Shopper

This represents a customer who is making the purchase. The Shopper is represented by a unique Identifier (Shopper ID) generated to secure payment information.

Shopper Object

Parameter name	Type	Description
id	String	Shopper ID generated by Coda
partner_shopper_id	String	ID the partner will use to identify their customer and link the token ID
phone_number	String	Shopper phone number
email	String	Shopper email address
status_code	String	Shopper status can be “active” or “inactive”

Base URL

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

Endpoints

Unset

POST {Base URL}/v1/shoppers
GET {Base URL}/v1/shoppers/{shopper.id}

Create Shopper

POST /shoppers

Unset

curl --location '{baseUrl}/v1/shoppers' \
--header 'X-Partner-Id: par_sg1882402279a0000' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: sdirugnvsiguhsirghsekjhgh' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwYXJ0bmVyX2lkIjoicGFyX3NnMTg4MjQwMjI3OWEwMDAwIiwiaWF0IjoxNzAxMjMzNTM0fQ.o_tcEJUEwEms49J0MXwvRuCGbsBx3rHugfgKsXVgj9I' \
--data-raw '{
  "partner_shopper_id": "partner-shopper-287",
  "phone_number": "[phone]",
  "email": "[e-mail]"
}'

Response Shopper Object

Unset

{
    "id": "shp_sg18bfb6894ea0000",
    "partner_shopper_id": "partner-shopper-345",
    "phone_number": "[phone]",
    "email": "[e-mail]",
    "status_code": "active"
}

Retrieve Shopper

Retrieve a shopper by shopper id

GET /shoppers/{shopper.id}

Unset

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

Response Shopper Object

Unset

{
    "id": "shp_sg18bfb6894ea0000",
    "partner_shopper_id": "partner-shopper-345",
    "phone_number": "[phone]",
    "email": "[e-mail]",
    "status_code": "active"
}

Request Parameters

Parameter name	Type	Required?	Description	Validation
partner_shopper_id	String	Yes	ID the partner will use to identify their customer and link the token ID	Size must be between 4 and 32 Must match "^[a-zA-Z0-9-_]+$"
phone_number	String	No	Customer phone number	Size must be between 12 and 16 Must match "\+[0-9]+"
email	String	No	Customer email address	Size must be between 4 and 128 Must match "^[^\\\"!#$%&'*+\\-/=?^_`{|]+[^\\\"]*[^\\\"!#$%&'*+\\-/=?^_`{|]+@[a-zA-Z0-9-]+([\\.][a-zA-Z0-9-]+){1,2}$"