Get Withdrawal Recipient

GET 
/v2/customers/:customerId/recipients/:recipientId

Returns single third-party withdrawal recipient.

Request

Path Parameters

customerId stringrequired

Customer Id.

recipientId stringrequired

Recipient Id.

Responses

200

OK

application/json

Schema

Schema

id stringrequired

Withdrawal recipient id.

status WithdrawalRecipientStatus (string)required

Possible values: [ACTIVE, INACTIVE]

Recipient status. Recipients are not deleted but kept for reference. Only ACTIVE recipients can be used for withdrawals.

creationTime date-timerequired

Represents RFC 3339, section 5.6 date-time.

label string

Possible values: non-empty and <= 100 characters

Label for the recipient. Use this field to label the recipient, if you want to make additional payments to the same party. If not specified the label is generated by combining the title, first name, and last name. If ACTIVE recipient with the same label already exists a number suffix is added.

title string

Possible values: <= 15 characters

Personal title, Mr., Dr., etc.

firstName stringrequired

Possible values: non-empty and <= 50 characters

First name. Only latin characters, spaces, single quotes, and hyphens are allowed.

lastName stringrequired

Possible values: non-empty and <= 50 characters

Last name. Only latin characters, spaces, single quotes, and hyphens are allowed.

address

object

required

Address of the customer.

countryCode CountryCode (string)required

Possible values: >= 2 characters and <= 2 characters

ISO-3166 Alpha 2

stateProvince string

Possible values: <= 2 characters

US state postal abbreviation. Not used for non-US territories.

city stringrequired

Possible values: <= 50 characters

City.

postalCode stringrequired

Possible values: non-empty and <= 50 characters

Postal code.

address1 stringrequired

Possible values: <= 200 characters

The first line of the address.

address2 string

Possible values: <= 200 characters

The second line of the address.

contactInfo

object

Represents contact information.

mobile string

Possible values: <= 50 characters

Mobile number.

email email

Possible values: >= 6 characters and <= 100 characters

Email.

paymentInstrument

object

required

Represents a payment instrument, used for third-party payments. Here are the valid instrumentType values:

• SEPA_BANK_ACCOUNT - IBAN Bank Account for EEA international transfers

• UK_BANK_ACCOUNT - UK Bank Account for somestic UK transfers

• US_BANK_ACCOUNT - US Bank Account for domestic USA transfers

id uuid

The instrument id

instrumentType

string

required

Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT]

Represents the type of the recipient instrument.

Value	Description
SEPA_BANK_ACCOUNT	SEPA Bank account
UK_BANK_ACCOUNT	UK Bank account
US_BANK_ACCOUNT	US Bank account

SEPA_BANK_ACCOUNT

accountHolderName string

Possible values: <= 100 characters

This is the name of the customer or company that owns the bank account.

iban stringrequired

The International Bank Account Number (IBAN) of the account.

bic stringrequired

The Bank Account Bank Identifier Code (BIC) code. Also known as SWIFT code.

bankName string

The bank name.

UK_BANK_ACCOUNT

accountHolderName string

Possible values: <= 100 characters

This is the name of the customer or company that owns the bank account.

accountNumber stringrequired

The bank account number.

sortCode stringrequired

Use our sort code checker to easily find and check UK sort codes.

bankName string

The bank name.

US_BANK_ACCOUNT

accountHolderName string

Possible values: <= 100 characters

This is the name of the customer or company that owns the bank account. As per regulations, the Wallet holder and bank account holder must be the same.

accountNumber stringrequired

Possible values: >= 4 characters and <= 17 characters

The bank account number.

routingNumber stringrequired

Possible values: >= 9 characters and <= 9 characters

For USD accounts, this is the 9-digit routing number of the bank.

bankName string

The bank name.

accountType string

Possible values: [SAVINGS, CHECKING, LOAN]

The account type.

type stringrequired

Possible values: [BUSINESS, INDIVIDUAL]

Recipient type.

Example (from schema)

{
  "id": "97266b06c85f4acd9a3f3aa0eed8b11e",
  "status": "ACTIVE",
  "creationTime": "2021-07-15T17:54:12Z",
  "label": "Supplier1",
  "title": "Mr.",
  "firstName": "Tom",
  "lastName": "Jones",
  "address": {
    "countryCode": "GB",
    "stateProvince": "string",
    "city": "London",
    "postalCode": "E1 6AN",
    "address1": "12 Brushfield Street",
    "address2": "string"
  },
  "contactInfo": {
    "mobile": "string",
    "email": "user@example.com"
  },
  "paymentInstrument": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "instrumentType": "US_BANK_ACCOUNT"
  },
  "type": "BUSINESS"
}

GET_RECIPIENT

{
  "id": "97266b06c85f4acd9a3f3aa0eed8b11e",
  "status": "ACTIVE",
  "creationTime": "2021-07-15T17:54:12Z",
  "label": "Supplier1",
  "title": "Mr.",
  "firstName": "Tom",
  "lastName": "Jones",
  "address": {
    "countryCode": "GB",
    "stateProvince": "st",
    "city": "London",
    "postalCode": "E1 6AN",
    "address1": "12 Brushfield Street"
  },
  "contactInfo": {
    "email": "user@example.com"
  },
  "paymentInstrument": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "instrumentType": "US_BANK_ACCOUNT",
    "accountHolderName": "John Doe",
    "accountNumber": "8451902456332",
    "routingNumber": "021000021",
    "bankName": "JPMorgan Chase",
    "accountType": "SAVINGS"
  },
  "type": "BUSINESS"
}

405

Method Not Allowed

application/json

Schema

Schema

error

object

Represents details of an error.

code string

The error code.

message string

The description of the error.

details string[]

Details for the errors of any parameter value.

fieldErrors

object[]

List of field errors associated with the main error.

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

DW-OPERATION-NOT-ALLOWED

{
  "error": {
    "code": "DW-OPERATION-NOT-ALLOWED",
    "message": "Operation is not allowed in your account. Contact Paysafe for further details.",
    "details": [
      "Operation is not allowed in your account. Contact Paysafe for further details."
    ]
  }
}

Loading...