Deactivate a Recipient
Permanently disable a Recipient
Path parameters
The unique identifier of the Recipient.
Body parameters
Allowed values: DEACTIVATED
The status of the recipient:
DEACTIVATED– Value to send to permanently disable the recipient so it can no longer be used. The Recipient must beACTIVEto be deactivated.
Responses
200
200
Max length: 128 characters (see data formats for details)
The unique identifier of the object.
Possible values: PENDING, CANCELED, ACTIVE, DEACTIVATED
The status of the recipient:
PENDING– ForPAYOUTscope recipients, the user must complete SCA before the recipient can becomeACTIVE. ForPAYINscope recipients, the recipient creation is in progress.CANCELED– SCA was not successfully completed and the recipient creation request was canceled. To retry, create another recipient to retrieve anotherPendingUserAction.RedirectUrl. TheCANCELEDstatus does not apply ifRecipientScopeisPAYIN.ACTIVE– Recipient creation was successful (including SCA ifRecipientScopeisPAYOUT) and the recipient is ready to be used for payouts .DEACTIVATED– The recipient has been permanently deactivated and can no longer be used.
The date and time at which the object was created.
Length: 1–50; cannot contain: &,'/ (pattern:^(?!.*[&,'/]).{1,50}$)
A user-friendly name to identify the account. This value cannot be changed once the recipient is created.
Possible values: InternationalBankTransfer, LocalBankTransfer
The payout method of the recipient.
InternationalBankTransfer– A bank wire transfer sent via SWIFT, requiring theInternationalBankTransferproperty.LocalBankTransfer– A bank wire transfer sent via local routes, requiring theLocalBankTransferproperty.
Possible values: Individual, Business
The recipient type:
Individual– An account held by a natural person, requiring theIndividualRecipientproperty.Business– An account held by a legal entity, requiring theBusinessRecipientproperty.
Possible values: AED, AUD, CAD, CHF, CNH, CZK, DKK, EUR, GBP, HKD, HUF, ILS, JPY, MXN, NOK, NZD, PLN, RON, SAR, SEK, SGD, TRY, USD, ZAR
The currency of the recipient.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)
The destination country of the payout method.
The unique identifier of the user.
Possible values: PAYIN, PAYOUT
Default value: PAYOUT
The scope of the recipient:
PAYOUT– Usable for payouts and in pay-in use cases. APAYOUTrecipient can only be created by a user with theUserCategoryOWNERand requires SCA. You need to use the returnedPendingUserAction.RedirectUrlvalue, adding your encodedreturnUrlas a query parameter, to redirect the user to the hosted SCA session so they can complete the necessary steps.PAYIN- Not usable for payouts but only usable for pay-in use cases, such as direct debit and refunds using payouts. APAYINrecipient can be created by a user with theUserCategoryPAYERorOWNER, and does not require SCA.
Both PAYIN and PAYOUT scopes can be created for either InternationalBankTransfer or LocalBankTransfer, and for either IndividualRecipient or BusinessRecipient, and for any Currency.
Max. length: 255 (pattern: ^.{0,255}$)
Custom data that you can add to this object. This value cannot be changed once the recipient is created.
The account holder if the RecipientType is Individual.
The account details if PayoutMethodType is InternationalBankTransfer.
The account details if PayoutMethodType is InternationalBankTransfer.
Object containing the link needed for SCA redirection if triggered by the API call (otherwise returned null).
400 - Recipient not ACTIVE
400 - Recipient not ACTIVE