Skip to navigation
Virtual Card Management

Cancel Virtual Card Accounts

View as Markdown
Cancel a virtual card when it is no longer needed.

Authentication

AuthorizationBearer

Headers

AuthorizationstringRequired
Oauth token
countrystringRequired
country of the Client
regionstringRequired

region of the client(Apac/EMEA/NAM)

req-sys-idstringRequired

Client Unique id to identify the particular request.
Format: UUID
Example: 123d837e-958a-4e9f-bc97-4843ec948123

Request

Request body description
vcaIdslist of stringsRequired
Unique Identifier for each Virtual card request.
programIdstringRequired
Unique ID of the company record defined in the virtual cards system.
messageIdstringRequired
Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration.
virtualCardAccountNumberstringOptional
The virtual card account number for which the modifications are requested.

Response

Cancel Virtual Card response
programIdstringOptional
Unique ID of the company record defined in the virtual cards system.
messageIdstringOptional
Unique ID of the API message sent. The messageId will be provided back in the corresponding response. The ID can be used for investigation and troubleshooting. The ID must be unique per integration.
vcaResponselist of objectsOptional

Errors

400
Bad Request Error
401
Unauthorized Error
405
Method Not Allowed Error
500
Internal Server Error