Update recipient with payment details

put

https://api-business.wirexapp.com/api/v2/recipients/{recipientId}

Updates recipient with personal information and payment details in a single request

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

recipientId

string

required

Unique identifier of the recipient on which the operation is to be performed

Body Params

Body data

ach

object

Payment details for ACH payments (MUST be provided if the type is Ach)

bi_fast

object

Payment details for BI-FAST payments

card

object

Payment details for card payments (MUST be provided if the type is Card)

company_name

string

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

crypto

object

Payment details for crypto payments (MUST be provided if the type is Crypto)

currencies

array of strings

required

List of currencies that the recipient can accept

currencies*

faster_payments

object

Payment details for FasterPayment payments (MUST be provided if the type is FasterPayment)

first_name

string

First name of the recipient (MUST be provided if the recipient is a person and no nickname is provided for crypto type)

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

is_business

boolean

required

Indicator of whether the recipient is a business

last_name

string

Last name of the recipient (MUST be provided if the recipient is a person and no nickname is provided for crypto type)

nick_name

string

Optional nickname for the recipient (max 127 characters)

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 (MUST be provided if type recipient is Sepa)

spei

object

Payment details for SPEI payments (MUST be provided if the type is SPEI)

swift

object

Payment details for SWIFT payments (MUST be provided if the type is Swift)

type

string

enum

required

Type of the payment details

Responses

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request

500Internal Server Error