Payments API Flow

Our new set of Payments API allows merchants to integrate to any of our supported money-in payment channels using a consolidated and unified set of APIs. Through these APIs, merchants are able to use the same endpoint for any payment method type in any supported market.

As stated in the picture above, it’s easy to understand the concept of Payments API. First Let’s define the action that possibly happened in the general happy payment flow

  1. The shopper chooses a payment method to make the payment.
  2. Merchant initiates bank/e-wallet account linking to Xendit (For Direct Debit, Ewallet, and Cards).
  3. Shopper authorizes for account linking (For Direct Debit, Ewallet, and Cards).
  4. Shoppers buy a product and initiate payment.
  5. The merchant initiates a payment request to Xendit.
  6. The shopper authorizes the payment.
  7. The shopper receives payment is approved and successful.
  8. If needed, the Shopper can ask for a refund payment.

Based on these steps, Payments API simplifies the integration to 3 API endpoints (Payment Method API, Payment Request API, and Refund API) to minimize the burden of adding new channels and reduce disruption due to possible breaking changes due to parameter/flow changes.

Based on the payment flow, Payments API is divided into 3:

Payment Methods API

Represents the instrument, source, or mode of payment. This can be a tokenized reusable payment source or a one-off payment. This account linking flow would be useful for the case of Direct Debit, Ewallet, and Cards where customer authorization action is needed. For example, if You want to link your end-customer direct debit account, hence your end customer would be easier to make the subsequent payment which impacts the higher conversion rate.

Please refer to this API reference for the details API endpoint parameter.

Payment Requests API

Represent the intent to pay and initiate a transaction. This also allows the end customer to perform payment and then save the payment method to be used for future transactions using the payment method ID. For the passive instruments/methods such as Virtual accounts, QR codes, or Retail Outlets, the API can be used to receive the payment number without payment method API.

Please refer to this API reference for the details API endpoint parameter.

Payment Object

The Payment Object unifies callback notification across all money-in channels. Please refer to this API reference for the details refund API endpoint parameter.

Last Updated on 2023-06-02