Deactivate a Recipient

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Returned values: PENDING, CANCELED, ACTIVE, DEACTIVATED

The status of the recipient:

• PENDING – For PAYOUT scope recipients, the user must complete SCA before the recipient can become ACTIVE. For PAYIN scope 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 another PendingUserAction.RedirectUrl. The CANCELED status does not apply if RecipientScope is PAYIN.
• ACTIVE – Recipient creation was successful (including SCA if RecipientScope is PAYOUT) and the recipient is ready to be used for payouts.
• DEACTIVATED – The recipient has been permanently deactivated and can no longer be used.

Unix timestamp (UTC) of the date and time 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.

Returned values: InternationalBankTransfer, LocalBankTransfer

The payout method of the recipient:

• LocalBankTransfer – The account can only receive the corresponding local Currency for the Country via the domestic payment rail (e.g. EUR via a SEPA local scheme to a SEPA country, GBP via FPS to a GB account, USD via ACH to a US account, etc). Payouts in non-local currencies return an error.
• InternationalBankTransfer – The account can receive both non-local currencies via SWIFT and also local currency via domestic rails.

Returned values: Individual, Business

The recipient type:

• Individual – An account held by a natural person, requiring the IndividualRecipient property.
• Business – An account held by a legal entity, requiring the BusinessRecipient property.

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.

Returned values: PAYIN, PAYOUT

The scope of the recipient:

• PAYOUT – Usable for payouts and in pay-in use cases. A PAYOUT recipient can only be created by a user with the UserCategory OWNER and requires SCA.
• PAYIN - Not usable for payouts but only usable for pay-in use cases, such as direct debit and refunds using payouts. A PAYIN recipient can be created by a user with the UserCategory PAYER or OWNER, 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.

Returned values: USER_PRESENT, USER_NOT_PRESENT

The SCA context provided in the create request. Returned in the create response and when viewing the recipient if a ScaContext value was sent when the recipient was registered. Omitted otherwise.

The account holder if the RecipientType is Individual.

The account holder if the RecipientType is Business.

The account details if PayoutMethodType is InternationalBankTransfer.

The account details if PayoutMethodType is LocalBankTransfer, depending on the Currency. One of:

Object containing the RedirectUrl needed for SCA redirection if triggered by the API call (otherwise returned null).