Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Orum generated unique id for the resource for the card you are fetching.
Response
200 response.
curl --request GET \
--url https://api-sandbox.orum.io/deliver/cards/{id} \
--header 'Authorization: Bearer <token>'
{
"card": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_reference_id": "<string>",
"customer_reference_id": "<string>",
"customer_resource_type": "business",
"account_holder_name": {
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"suffix": "<string>"
},
"status": "created",
"pull_eligible": true,
"push_eligible": true,
"address": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "billing",
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "US",
"zip5": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"closed_at": "2023-11-07T05:31:56Z",
"metadata": {},
"last4": "<string>",
"expiration_month": 6,
"expiration_year": 2025,
"status_reasons": [
{
"reason_code": "invalid_address",
"reason_code_message": "Address submitted is a non-supported address type"
}
]
}
}
Get a card object by id.
curl --request GET \
--url https://api-sandbox.orum.io/deliver/cards/{id} \
--header 'Authorization: Bearer <token>'
{
"card": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_reference_id": "<string>",
"customer_reference_id": "<string>",
"customer_resource_type": "business",
"account_holder_name": {
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"suffix": "<string>"
},
"status": "created",
"pull_eligible": true,
"push_eligible": true,
"address": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "billing",
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "US",
"zip5": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"closed_at": "2023-11-07T05:31:56Z",
"metadata": {},
"last4": "<string>",
"expiration_month": 6,
"expiration_year": 2025,
"status_reasons": [
{
"reason_code": "invalid_address",
"reason_code_message": "Address submitted is a non-supported address type"
}
]
}
}
The access token received from the authorization server in the OAuth 2.0 flow.
Orum generated unique id for the resource for the card you are fetching.
200 response.
Show child attributes
Was this page helpful?