Auth API
- How to authenticate
Deliver API
- Persons
- Businesses
- External Accounts
- Cards
- Transfers
- Eligibility
- Transfer Groups
- Balance
- Reports
Verify API
Webhooks API
- Overview And Set Up
- Event Types and Payloads
- Configure webhooks
- Trigger webhooks
- Secure webhooks
Close A Card By ID
Close a card object so they are unable to transact.
curl --request DELETE \
--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"
}
]
}
}Authorizations
The auth token received from Authentication endpoints.
Path Parameters
Orum generated unique id for the resource for the card you are fetching.
Response
Orum generated unique id for the resource.
Unique reference id for the card. Generated by you.
1 - 255Unique reference id for the customer (business or person) resource. Generated by you.
1 - 255Type of customer resource - business, person, or enterprise.
business, person, enterprise Name of account holder.
Accepts latin characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.
1 - 255Accepts latin characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.
1 - 255Accepts latin characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.
255Accepts alphanumeric characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.
255Status of card in Orum system.
created, verified, rejected, closed Address.
Orum generated unique id for the resource.
Type of address. Always 'billing' for card object.
billing 5-digit ZIP Code. Numeric values (0-9) only.
Timestamp when the resource was created.
Timestamp when the resource was last updated.
Address line 1.
255Address line 2.
255City.
255Uppercase two-character state code of the address.
2-character ISO country code.
US Timestamp when the resource was created.
Timestamp when the resource was last updated.
The last four digits of the card number supplied by the customer.
The month in which the card expires.
1 <= x <= 12The year in which the card expires.
x >= 2024Indicates that the card can be used for pull transactions.
Indicates that the card can be used for push transactions.
Timestamp when the status of the resource was set to "closed".
Additional data you would like to provide on the resource. The field supports valid JSON of up to 5 key-value pairs with a maximum of 20 characters for the key and 50 characters for the value. Do not include any sensitive information.
Array that explains why the person failed verification.
Was this page helpful?
curl --request DELETE \
--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"
}
]
}
}