API ReferenceCustomersAPI IntegrationRecipients

Delete recipient

This OAuth 2.0 authenticated API performs a soft deletion of the recipient by setting it to an inactive state, preventing its use in new transactions while retaining historical records.

Authentication

AuthorizationBearer

OAuth 2.0 Bearer token authentication. This API uses OAuth 2.0 Client Credentials flow. Please refer to the Authentication section for detailed information on how to obtain and use your OAuth credentials.

Path parameters

customer_idstringRequired
Unique identifier for the customer to whom the recipient belongs.
recipient_idstringRequired
Unique identifier of the recipient to be deleted.

Response

Successfully deleted a Recipient's account.
codestring
Code should be '000'.
descriptionstring
Message should be 'Operation completed successfully'.

Errors