v1

latestOpenAPI 3.0.02026-07-24126202516.7 KB

Card Accounts

Create Card Account

Create a Credit Card Account to be used as a funding source. Store the returned :id and use it for a make_payment Item Action call. The :id is also referred to as a token when involving Credit Cards.

post/card_accounts

Request body

full_namestring required

User full name with at least a space

numberstring required

Account number

expiry_monthinteger required

Expiry month (MM)

expiry_yearinteger required

Expiry year (YYYY)

cvvstring required

CVV / CVC

user_idstring required

User ID

Example request

{
  "full_name": "John Doe",
  "number": "4444111122223333",
  "cvv": "123",
  "user_id": "83f54680-9600-4bee-a6d1-84a5d0e10059"
}

Response

Example response

{
  "card_accounts": {
    "active": true,
    "id": "46deb476-c1a6-41eb-8eb7-26a695bbe5bc",
    "currency": "AUD",
    "cvv_verified": true,
    "verification_status": "not_verified",
    "card": {
      "type": "visa",
      "full_name": "Bella Buyer",
      "number": "XXXX-XXXX-XXXX-1111"
    },
    "links": {
      "self": "/users/buyer-71439598/card_accounts",
      "users": "/card_accounts/35977230-7168-0138-0a1d-0a58a9feac07/users"
    }
  }
}