Skip to main content
PUT
/
v2.01
/
{ClientId}
/
recipients
/
{RecipientId}
{
    "Status": "DEACTIVATED"
}

{
    "Id": "rec_01JRAEAA2RBYFV0MQD0K49221G",
    "Status": "DEACTIVATED",
    "CreationDate": 1744107284,
    "DisplayName": "Alex Smith EUR international pay-in account",
    "PayoutMethodType": "InternationalBankTransfer",
    "RecipientType": "Business",
    "Currency": "EUR",
    "Country": "FR",
    "UserId": "user_m_01JRADX7YD0060N5VAA0XPMM54",
    "RecipientScope": "PAYIN",
    "Tag": "Created using the Mangopay API Postman collection",
    "BusinessRecipient": {
        "BusinessName": "Alex Smith Consulting",
        "Address": {
            "AddressLine1": "3 rue de la Cité",
            "AddressLine2": "Appartement 7",
            "City": "Paris",
            "Region": "Ile de France",
            "PostalCode": "75001",
            "Country": "FR"
        }
    },
    "InternationalBankTransfer": {
        "IBAN": "FR7630004000031234567890143",
        "BIC": "BNPAFRPPXXX"
    }
}

​
Path parameters

​
RecipientId
string
required
The unique identifier of the Recipient or legacy Bank Account (the legacy BankAccountId value can be used on this endpoint).

​
Body parameters

​
Status
string
Allowed values: DEACTIVATEDThe status of the recipient:
  • DEACTIVATED – Value to send to permanently disable the recipient so it can no longer be used. The Recipient must be ACTIVE to be deactivated.

​
Responses

​
Id
string
Max length: 128 characters (see data formats for details)The unique identifier of the object.
​
Status
string
Possible values: PENDING, CANCELED, ACTIVE, DEACTIVATEDThe 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.
​
CreationDate
Unix timestamp
The date and time at which the object was created.
​
DisplayName
string
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.
​
PayoutMethodType
string
Possible values: InternationalBankTransfer, LocalBankTransferThe payout method of the recipient.
  • InternationalBankTransfer – A bank wire transfer sent via SWIFT, requiring the InternationalBankTransfer property.
  • LocalBankTransfer – A bank wire transfer sent via local routes, requiring the LocalBankTransfer property.
​
RecipientType
string
Possible values: Individual, BusinessThe 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.
​
Currency
string
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, ZARThe currency of the recipient.
​
Country
string
Format: Two-letter country code (ISO 3166-1 alpha-2 format)The destination country of the payout method.
​
UserId
string
The unique identifier of the user.
​
RecipientScope
string
Possible values: PAYIN, PAYOUTDefault value: PAYOUTThe 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. You need to use the returned PendingUserAction.RedirectUrl value, adding your encoded returnUrl as 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. 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.
​
Tag
string
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.
  • Individual
  • Business
​
IndividualRecipient
object
The account holder if the RecipientType is Individual.

  • InternationalBankTransfer
  • LocalBankTransfer
​
InternationalBankTransfer
object
The account details if PayoutMethodType is InternationalBankTransfer.
​
PendingUserAction
object
Object containing the link needed for SCA redirection if triggered by the API call (otherwise returned null).

400 - Recipient not ACTIVE

{
    "Id": "5c9ea5c63a80ddd7e5d77ef04cf5ed0d",
    "Message": "Invalid State",
    "Type": "other",
    "Date": 1739485283,
    "Errors": null
}

{
    "Id": "rec_01JRAEAA2RBYFV0MQD0K49221G",
    "Status": "DEACTIVATED",
    "CreationDate": 1744107284,
    "DisplayName": "Alex Smith EUR international pay-in account",
    "PayoutMethodType": "InternationalBankTransfer",
    "RecipientType": "Business",
    "Currency": "EUR",
    "Country": "FR",
    "UserId": "user_m_01JRADX7YD0060N5VAA0XPMM54",
    "RecipientScope": "PAYIN",
    "Tag": "Created using the Mangopay API Postman collection",
    "BusinessRecipient": {
        "BusinessName": "Alex Smith Consulting",
        "Address": {
            "AddressLine1": "3 rue de la Cité",
            "AddressLine2": "Appartement 7",
            "City": "Paris",
            "Region": "Ile de France",
            "PostalCode": "75001",
            "Country": "FR"
        }
    },
    "InternationalBankTransfer": {
        "IBAN": "FR7630004000031234567890143",
        "BIC": "BNPAFRPPXXX"
    }
}

{
    "Status": "DEACTIVATED"
}