Payment Method

Payment Method represents the shopper's preferred payment instrument that intends to use for transactions e.g credit cards, digital wallet.

Payment Method Object

Parameter name	Type	Description
id	String	Payment Method ID generated by Coda
shopper_id	String	Shopper ID generated by Coda
type	String	Type of the payment method
Object	Object	Payment Type Object and it will vary depending on specific payment type and Refers to the relevant Payment Object for more details

Base URL

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

Endpoints

Unset

POST {Base URL}/v1/payment-methods
GET  {Base URL}/v1/payment-methods/{paymentmethod.id}

Create Payment Method

POST /payment-methods

Unset

curl --location '{baseUrl}/v1/payment-methods' \
--header 'X-Partner-Id: par_sg1882402279a0000' \
--header 'X-Api-Key: sdirugnvsiguhsirghsekjhgh' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwYXJ0bmVyX2lkIjoicGFyX3NnMTg4MjQwMjI3OWEwMDAwIiwiaWF0IjoxNzAxMjMzNTM0fQ.o_tcEJUEwEms49J0MXwvRuCGbsBx3rHugfgKsXVgj9I' \
--data '{
  "shopper_id": "shp_sg18c196c9bd50006",
  "type": "card",
  "card": {
    "country_code": "SA"
  }
}'

Response Payment Method Object

Unset

{
    "id": "pmt_sg18bfbbbcb680002",
    "shopper_id": "shp_sg18bfb6894ea0000",
    "type": "card",
    "card": {
        "id": "crd_sg18bfbbbcc4b0001",
        "country_code": "SA",
    "last_four": null
    }
}

Retrieve Payment Method

GET /payment-methods/{paymentmethod.id}

Unset

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

Response Payment Method Object

Unset

{
    "id": "pmt_sg18bfbbbcb680002",
    "shopper_id": "shp_sg18bfb6894ea0000",
    "type": "card",
    "card": {
        "id": "crd_sg18bfbbbcc4b0001",
        "country_code": "SA",
    "last_four": xxxx
    }
}

Request Parameters

Parameter Name	Type	Required	Description	Validation
shopper_id	String	Yes	Shopper ID generated by Coda	Size must be between 20 and 32 Must match "[A-Za-z]+_[A-Za-z0-9]+
type	String	Yes	Type of the payment method. Available types: Refer to Payment Method	Size must be between 3 and 64 Must match "[a-zA-Z0-9_]+"
Object	Object	Yes	Refer to Payment Method Details Chapter	Numeric not null