Overview
User management
- Users
- User regulatory status
- User e-money
User verification
- IDV sessions
- User data format
- KYC documents
- UBO declarations
Wallets
- User wallets
- Client wallets
Cards
- Card registrations
- Cards
- Metadata
- Card validations
Card pay-ins
- Direct card pay-ins
- Recurring card pay-ins
- Preauthorizations
- Deposit preauthorizations
- Web card pay-ins
Banking pay-ins
- Bank wires
- Pay by bank
- Virtual IBAN
- Direct debits
- Web direct debits
APM pay-ins
- Apple Pay
- Bancontact
- BLIK
- Giropay
- Google Pay
- iDEAL
- Klarna
- MB WAY
- Multibanco
- Payconiq
- PayPal
- Satispay
- Swish
- TWINT
Transfers
- Transfers
Refunds
- Refunds
Disputes
- Disputes
- Dispute documents
- Repudiations
- Dispute settlement
Payouts
FX conversions
- Conversion rates
- Quotes
- Conversions
Transactions
- Transactions
Helpers
- API responses
- Country authorizations
- Webhooks
- Events
- Reports
Platform account
- Client
- Dashboard permissions
List Recipients for a User
List recipients created for a UserId
[
{
"Id": "rec_01JV700CD7E5GP9SFZHGX0RV2E",
"DisplayName": "Alex Smith USD account",
"PayoutMethodType": "LocalBankTransfer",
"RecipientType": "Individual",
"Currency": "USD",
"Country": "US",
"UserId": "user_m_01JV6ZGXBE0VZSF4TEN9JK343Z",
"Status": "ACTIVE",
"RecipientScope": "PAYOUT"
},
{
"Id": "rec_01JV6ZZG6W0RKG6ZGA3MEY60BZ",
"DisplayName": "Alex Smith USD account",
"PayoutMethodType": "LocalBankTransfer",
"RecipientType": "Individual",
"Currency": "USD",
"Country": "US",
"UserId": "user_m_01JV6ZGXBE0VZSF4TEN9JK343Z",
"Status": "CANCELED",
"RecipientScope": "PAYOUT"
},
{
"Id": "rec_01JV70P7J10PRZP0JQQ9CQZFN8",
"DisplayName": "Alex Smith EUR account",
"PayoutMethodType": "InternationalBankTransfer",
"RecipientType": "Business",
"Currency": "EUR",
"Country": "FR",
"UserId": "user_m_01JV6ZGXBE0VZSF4TEN9JK343Z",
"Status": "ACTIVE",
"RecipientScope": "PAYOUT"
}
]Note – Endpoint returns filtered list by default
By default, this endpoint returns only recipients with the RecipientScope value of PAYOUT. To retrieve PAYIN recipients, you need to specify the value in the RecipientScope query parameter.
Path parameters
The unique identifier of the user.
Query parameters
Possible values: PAYIN
By default, this endpoint returns only recipients with the RecipientScope value of PAYOUT unless PAYIN is specified as the query parameter value. It is also not possible to combine the query values.
Read more about recipient scopes in the guide.
Responses
The list of recipients created for the user.
The unique identifier of the object.
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: AUD, CAD, EUR, GBP, HKD, SGD, USD
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: 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.
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.
[
{
"Id": "rec_01JV700CD7E5GP9SFZHGX0RV2E",
"DisplayName": "Alex Smith USD account",
"PayoutMethodType": "LocalBankTransfer",
"RecipientType": "Individual",
"Currency": "USD",
"Country": "US",
"UserId": "user_m_01JV6ZGXBE0VZSF4TEN9JK343Z",
"Status": "ACTIVE",
"RecipientScope": "PAYOUT"
},
{
"Id": "rec_01JV6ZZG6W0RKG6ZGA3MEY60BZ",
"DisplayName": "Alex Smith USD account",
"PayoutMethodType": "LocalBankTransfer",
"RecipientType": "Individual",
"Currency": "USD",
"Country": "US",
"UserId": "user_m_01JV6ZGXBE0VZSF4TEN9JK343Z",
"Status": "CANCELED",
"RecipientScope": "PAYOUT"
},
{
"Id": "rec_01JV70P7J10PRZP0JQQ9CQZFN8",
"DisplayName": "Alex Smith EUR account",
"PayoutMethodType": "InternationalBankTransfer",
"RecipientType": "Business",
"Currency": "EUR",
"Country": "FR",
"UserId": "user_m_01JV6ZGXBE0VZSF4TEN9JK343Z",
"Status": "ACTIVE",
"RecipientScope": "PAYOUT"
}
]Was this page helpful?
[
{
"Id": "rec_01JV700CD7E5GP9SFZHGX0RV2E",
"DisplayName": "Alex Smith USD account",
"PayoutMethodType": "LocalBankTransfer",
"RecipientType": "Individual",
"Currency": "USD",
"Country": "US",
"UserId": "user_m_01JV6ZGXBE0VZSF4TEN9JK343Z",
"Status": "ACTIVE",
"RecipientScope": "PAYOUT"
},
{
"Id": "rec_01JV6ZZG6W0RKG6ZGA3MEY60BZ",
"DisplayName": "Alex Smith USD account",
"PayoutMethodType": "LocalBankTransfer",
"RecipientType": "Individual",
"Currency": "USD",
"Country": "US",
"UserId": "user_m_01JV6ZGXBE0VZSF4TEN9JK343Z",
"Status": "CANCELED",
"RecipientScope": "PAYOUT"
},
{
"Id": "rec_01JV70P7J10PRZP0JQQ9CQZFN8",
"DisplayName": "Alex Smith EUR account",
"PayoutMethodType": "InternationalBankTransfer",
"RecipientType": "Business",
"Currency": "EUR",
"Country": "FR",
"UserId": "user_m_01JV6ZGXBE0VZSF4TEN9JK343Z",
"Status": "ACTIVE",
"RecipientScope": "PAYOUT"
}
]