This guide explains how to deactivate a recipients using the orda API. Deactivating a recipients ensures that the recipient no longer receives payouts or processes transactions. This is particularly useful when a recipient is no longer active or needs to be disabled for security or operational reasons.

AuthenticationCopied!

To deactivate a recipient, you must authenticate your request using your project’s client ID and secret. Each request must include:

• An x-signature header that is generated using your client secret.

• An x-client-id header containing your project’s client ID.

Refer to the authentication guide for detailed instructions on generating the correct signature.

Common IssuesCopied!

• Missing or Invalid Signature: Ensure that every deactivation request is properly signed with an x-signature derived from your client secret.

• Incorrect Recipient Identification: Double-check that the recipient you are deactivating is the intended one to prevent accidental deactivation.

• Mismatched Client ID: Verify that the x-client-id provided in the request corresponds to the correct project.

When to use this endpointCopied!

Deactivating a recipient is recommended when:

• An entity (such as a vendor or partner) no longer requires settlement services.

• Security or compliance reasons necessitate revoking a recipient’s ability to process payouts.

• You need to manage recipients’ activity through your administrative controls rather than manual intervention.

For implementation details, including the precise request format, please refer to the API reference.