Tokenization API

Overview

Tokenization is a process that enables users to effortlessly gather authorization and collect payments for one-click purchases or subscriptions provided by Codapay. Thanks to Codapay, users have access to a range of payment channels, while providing comprehensive methods to conveniently charge users whenever necessary.

How does tokenization work?

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

  1. Securely store user payment information.

  2. Efficiently charge users.

  3. Monitor charge status.

  4. Initiate recurring charges for subscription services.

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

  • Active or 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. A payment method can be identified by the following information:

  • Payment Method ID (Coda will generate)

  • Shopper ID (Partner initially generated with Coda)

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

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 (Partner 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 (Partner initially generated with Coda)

  • Product details (item name)

  • Amount to be charged

  • Status (whether 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

Last updated