API Reference

Create recipient with payment details

post
https://api-baas.wirexapp.com/api/v2/recipients

Creates recipient with personal info and payment details in a single call

Body Params

Body data

ach
object

Payment details for ACH payments

bi_fast
object

Payment details for BI-FAST payments

card
object

Payment details for card payments

string

Name of the company/business this recipient is for (MUST be provided if the recipient is a business and not crypto with nickname)

crypto
object

Payment details for crypto payments

currencies
array of strings
required

List of currencies that the recipient can accept

currencies*
faster_payments
object

Payment details for FasterPayment payments

string

First name of the recipient (MUST be provided if the recipient is a person and not crypto with nickname)

fps_hk
object

Payment details for FPS Hong Kong payments

imps
object

Payment details for IMPS payments

instapay
object

Payment details for InstaPay payments

ipp
object

Payment details for IPP payments

boolean
required

Indicator of whether the recipient is a business

string

Last name of the recipient (MUST be provided if the recipient is a person and not crypto with nickname)

string
length ≤ 127

Optional nickname for the recipient (max 127 characters). For crypto recipients, nickname can replace first/last/company name.

nip
object

Payment details for NIP payments

pix
object

Payment details for PIX payments

pse
object

Payment details for PSE payments

sepa
object

Payment details for SEPA payments

spei
object

Payment details for SPEI payments

swift
object

Payment details for SWIFT payments

type
object
required

Type of the payment details

Responses

Updated about 2 months ago

Language
Credentials
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 months ago