Token

This will generate a token, which is a random alphanumeric string . This token is unique to the specific payment method information provided by the shopper.

Token Object

Parameter name	Type	Description
id	String	Token ID generated by Coda
payment_method_id	String	Payment Method ID generated by Coda
status_code	String	The status code of the token
shopper_action	Object	Details concerning the shopper interaction to authorize token
shopper_action.id	String	Id of the shopper action entity
shopper_action.type	String	Type of the shopper action. Possible value = ‘redirection’
shopper_action.redirection	Object	Detail of the redirection
shopper_action.redirection.id	String	Redirection ID
shopper_action.redirection.method	String	The HTTP method used for redirection. Possible values include ‘GET’, ‘POST’
shopper_action.redirection.url	String	The URL of the shopper redirection

Base URL

Version	Base URL
Sandbox	https://api-tc.codapayments-staging.com
Production	https://api-tc.codapayments.com

Endpoints

Unset

POST /v1/tokens
GET  /v1/tokens/{id}

Token Cancellation Object

Parameter name	Type	Description
id	String	Token Cancellation ID generated by Coda
reason	String	Reason for token cancellation
status_code	String	The status code of the canceled token
token_id	Object	Token ID provided for token cancellation

Endpoints

Unset

POST {Base URL}/v1/tokens
GET  {Base URL}/v1/tokens/{id}
POST {Base URL}/v1/tokens/{tokenId}/cancellations

Create Token

POST /tokens

Unset

curl --location '{baseUrl}/v1/tokens' \
--header 'X-Partner-Id: par_sg1882402279a0000' \
--header 'X-Api-Key: sdirugnvsiguhsirghsekjhgh' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwYXJ0bmVyX2lkIjoicGFyX3NnMTg4MjQwMjI3OWEwMDAwIiwiaWF0IjoxNzAxMjMzNTM0fQ.o_tcEJUEwEms49J0MXwvRuCGbsBx3rHugfgKsXVgj9I' \
--data '{
    "payment_method_id": "pmt_sg18c19753ad70005"
}'

Response Token Object

Unset

{
    "id": "tkn_sg18bff21b35d0000",
    "payment_method_id": "pmt_sg18bfbc3dab80003",
    "status_code": "waiting_for_shopper_action",
    "shopper_action": {
        "id": "tsa_sg18bff21c0810000",
        "type": "redirection",
        "redirection": {
            "id": "tar_sg18bff21c61e0000",
            "method": "GET",
            "url": "https://redirectionUrl.com"
        }
    }
}

Retrieve Token

GET /tokens/{token.id}

Unset

curl --location '{baseUrl}/v1/tokens/{tokenId}' \
--header 'X-Partner-Id: par_sg1882402279a0000' \
--header 'X-Api-Key: sdirugnvsiguhsirghsekjhgh' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwYXJ0bmVyX2lkIjoicGFyX3NnMTg4MjQwMjI3OWEwMDAwIiwiaWF0IjoxNzAxMjMzNTM0fQ.o_tcEJUEwEms49J0MXwvRuCGbsBx3rHugfgKsXVgj9I' \
--data ''

Response Token Object

Unset

{
    "id": "tkn_sg18bff21b35d0000",
    "payment_method_id": "pmt_sg18bfbc3dab80003",
    "status_code": "waiting_for_shopper_action",
    "shopper_action": {
        "id": "tsa_sg18bff21c0810000",
        "type": "redirection",
        "redirection": {
            "id": "tar_sg18bff21c61e0000",
            "method": "GET",
            "url": "https://www.redirectionUrl.com"
        }
    }
}

Request Parameters

Parameter Name	Type	Required	Description	Validation
payment_method_id	String	Yes	Payment Method ID generated by Coda	Size must be between 3 and 255 Must not be blank

Token Cancellation

POST /tokens/{tokenid}/cancellations

Unset

curl --location '{baseUrl}/v1//tokens/{tokenId}/cancellations' \
--header 'X-Partner-Id: par_sg18dd4d8cead0000' \
--header 'X-Api-Key: sdirugnvsiguhsirghsekjhgh' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwYXJ0bmVyX2lkIjoicGFyX3NnMThkZDRkOGNlYWQwMDAwIiwiaWF0IjoxNzA5MDEzMzAzfQ.Xz8kyTMqK3UYEjvKIzoBo2BtXKtVJ-5_IyzIgCVPgCE' \
--data '{
    "reason": "cancelled due to failure"
}'

Response Token Cancellation Object

Unset

{
    "id": "tkc_sg18de92f14190001",
    "reason": "cancelled due to failure",
    "status_code": "succeeded",
    "token_id": "tkn_sg18de8de4b420004"
}

Request Parameters

Parameter name	Type	Required?	Description	Validation
reason	String	No	Reason for token cancellation	The reason length must be between 1 and 255