2020-11-11: Littlepay Records - Enhancement to Micropayments Adjustment

As Littlepay, we offer the best trip fare for customers which means if there is a product that offers multi capping only one cap which results in the best fare would be selected. Some merchants reported that listing all the caps is resulting in erroneous reporting and they need a clear way to identify which cap was applied.

To make it easier for merchants to clearly identify which adjustment cap was selected for a specific trip, a new flag is introduced which makes it easier for merchants to identify which adjustment payment was selected if a micropayment has multiple adjustment payments.

An adjustment_id for micro-payments with applied status true is the selected adjustment for that micro-payment.

Instructions for usage

Field Name

Data Type

Description / Comments

micropayment_id

String

Identifies the micropayment that the adjustment belongs to.

Can be used to join to the Micropayment feed.

adjustment_id

String

Uniquely identifies the adjustment

participant_id

String

Identifies the participant that the adjustment belongs to.

Can be used to join to the Participant feed.

customer_id

String

Identifies the customer that the adjustment belongs to.

Can be used to join to the Customer feed.

product_id

String

Identifies the product that was used to adjust the micropayment.

Can be used to join the Product feed.

type

String enum. Valid values:

  • DAILY_CAP
  • WEEKLY_CAP
  • MULTI_DAY_CAP

The type of product / rule that created the adjustment. Additional values may be added over time.

description

String

General description of the reason the adjustment was created.

amount

Decimal

The amount deducted from the NominalAmount to arrive at the ChargeAmount for the micropayment being adjusted.

time_period_type

 

String enum. Valid values:

  • PEAK
  • OFFPEAK

Indicates whether the travel was determined to have occurred during peak or offpeak period for the purposes of capping.

applied

Boolean

  • true
  • false

Selected adjustment for this micropayment will have a status of TRUE.

New Field: applied (Highlighted in Green)



Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.