Archived - Tokenization API 2.0

Overview

Tokenization is a way for you to gather customer authorization and enable future payments through one-click or subscriptions via the supported payment channels offered by Codapay. As such, Codapay will provide all the necessary methods for you to be able to save a user’s payment method and conveniently charge users whenever necessary.

How does tokenization work?

For each payment channel supporting tokenization, Codapay provides four core functions:

1. Save a user payment information

2. Charge a user

3. Check a charge status

4. One Click or Initiate a recurring charge (subscription)

What is new in the docs?

Document Version	Updated Date	Comments
2.0	28.07.2023	Initial API Documentation
2.1	28.11.2023	Added Mada Webhook Security Request Headers Add Charge Shopper Action
2.2	28.02.2024	Added DANA Wallet Changed email validation shopper Added Account Unbinding Process

Definitions and Concepts

Shopper

Shopper ID is a unique identifier to be assigned to a customer. You can generate a shopper by calling the shopper endpoint. A shopper can be identified by the following information:

• Shopper ID (Coda will generate)

• Partner Shopper ID (corresponding to your own Customer Identifier)

• Email address

• Phone number

• Status Code (Active/Inactive)

Payment Method

Payment Method ID is a unique identifier to link a shopper and a payment method. You can refer to the list of available payment methods here. A payment method can be identified by the following information:

• Payment Method ID (Coda will generate)

• Shopper ID (that you initially generated with Coda)

• Type (corresponding to the name of the payment method, eg. Go-Pay, card)

• Specific Payment Method details (Refer to Payment Method Details Chapter)

Token

Token ID is a unique identifier to link a payment method and a token. A token can be identified by the following information:

• Token ID (Coda will generate)

• Payment Method ID (that you initially generated with Coda)

• Token status (active or expired)

Charge

Charge ID is a unique identifier to identify charge transactions. A charge can be identified by the following information:

• Charge ID (Coda will generate)

• Token ID (that you initially generated with Coda)

• Product details (Item name)

• Amount to be charged

• Status (If the charge has succeeded or not)

Subscription Plan

Subscription Plan can be identified by the following information:

• Subscription Plan ID (Coda will generate)

• Recurring Amount to be charged

• Recurrence (Every x weeks/months/quarters/years)

Subscription

Subscription can be identified by the following information:

• Subscription Plan ID

• Token ID