CardOrder

A card order: create one, list or get them, update its status, and check requirements, programs and addresses.

Operations

Every route this entity exposes. Each route links to its own reference on this page.

Examples

One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.

Golang

Construct client as shown in the Golang setup, then call the operations:

card_orders, err := client.CardOrder(nil).List(map[string]any{"profile_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(card_orders)
card_order, err := client.CardOrder(nil).Load(map[string]any{"id": 1, "profile_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(card_order)
created, err := client.CardOrder(nil).Create(map[string]any{"cardHolderName": "example", "program": "example"}, nil)
if err != nil {
    panic(err)
}
fmt.Println(created)
updated, err := client.CardOrder(nil).Update(map[string]any{"id": 1, "profile_id": 1, "status": "example"}, nil)
if err != nil {
    panic(err)
}
fmt.Println(updated)

Lua

Construct client as shown in the Lua setup, then call the operations:

local card_orders, err = client:CardOrder():list({ profile_id = 1 })
local card_order, err = client:CardOrder():load({ id = 1, profile_id = 1 })
local created, err = client:CardOrder():create({ cardHolderName = "example", program = "example" })
local updated, err = client:CardOrder():update({ id = 1, profile_id = 1, status = "example" })

PHP

Construct client as shown in the PHP setup, then call the operations:

$card_orders = $client->CardOrder()->list(["profile_id" => 1]);
$card_order = $client->CardOrder()->load(["id" => 1, "profile_id" => 1]);
$created = $client->CardOrder()->create(["cardHolderName" => "example", "program" => "example"]);
$updated = $client->CardOrder()->update(["id" => 1, "profile_id" => 1, "status" => "example"]);

Python

Construct client as shown in the Python setup, then call the operations:

card_orders = client.CardOrder().list({"profile_id": 1})
card_order = client.CardOrder().load({"id": 1, "profile_id": 1})
created = client.CardOrder().create({ "cardHolderName": "example", "program": "example" })
updated = client.CardOrder().update({"id": 1, "profile_id": 1, "status": "example"})

Ruby

Construct client as shown in the Ruby setup, then call the operations:

card_orders = client.CardOrder.list({ "profile_id" => 1 })
card_order = client.CardOrder.load({ "id" => 1, "profile_id" => 1 })
created = client.CardOrder.create({ "cardHolderName" => "example", "program" => "example" })
updated = client.CardOrder.update({ "id" => 1, "profile_id" => 1, "status" => "example" })

TypeScript

Construct client as shown in the TypeScript setup, then call the operations:

const card_orders = await client.CardOrder().list({ profile_id: 1 })
const card_order = await client.CardOrder().load({ id: 1, profile_id: 1 })
const created = await client.CardOrder().create({ cardHolderName: "example", program: "example" })
const updated = await client.CardOrder().update({ id: 1, profile_id: 1, status: "example" })

Fields

create

POST /spend/profiles/{profileId}/card-orders

Operation ID: cardOrderCreate.

Authentication: bearer token (UserToken).

Parameters

Request body

application/json

Responses

200: OK - Card order created successfully

application/json

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

POST /spend/address/validate

Operation ID: cardOrderValidateAddress.

Authentication: bearer token (UserToken).

Parameters

Request body

application/json

Responses

200: OK - Validation result returned. An empty errors collection means the address is valid

application/json

Example response:

{
  "errors": [
    {
      "field": "city",
      "message": "Required Field"
    },
    {
      "field": "postCode",
      "message": "Please enter a valid postcode"
    },
    {
      "field": "firstLine",
      "message": "Must be less than 30 characters"
    }
  ]
}

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

list

GET /spend/profiles/{profileId}/card-orders/{cardOrderId}/requirements

Operation ID: cardOrderRequirementsGet.

Authentication: bearer token (UserToken).

Parameters

Responses

200: OK - Successfully retrieved card order requirements

application/json

Example response:

{
  "requirements": [
    {
      "status": "NOT_INITIATED",
      "type": "PIN"
    },
    {
      "status": "PENDING",
      "type": "VERIFICATION"
    },
    {
      "status": "COMPLETED",
      "type": "ADDRESS"
    }
  ]
}

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

GET /spend/profiles/{profileId}/card-orders

Operation ID: cardOrderList.

Authentication: bearer token (UserToken).

Parameters

Responses

200: OK - Successfully retrieved card orders

application/json

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

GET /spend/profiles/{profileId}/card-orders/availability

Operation ID: cardOrderProgramsGet.

Authentication: bearer token (UserToken).

Parameters

Responses

200: OK - Successfully retrieved available card programs

application/json

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

load

GET /spend/profiles/{profileId}/card-orders/{cardOrderId}

Operation ID: cardOrderGet.

Authentication: bearer token (UserToken).

Parameters

Responses

200: OK - Successfully retrieved card order

application/json

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

update

PUT /spend/profiles/{profileId}/card-orders/{cardOrderId}/status

Operation ID: cardOrderStatusUpdate.

Authentication: bearer token (UserToken).

Parameters

Request body

application/json

Responses

202: Accepted - Card order status update has been accepted

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.