Get Withdrawal Recipients

GET 
/v2/customers/:customerId/recipients

Returns list of withdrawal recipients for a customer.

Each recipient has a state (ACTIVE, INACTIVE) and only ACTIVE recipients can be used for third-party withdrawals.

By default, only ACTIVE recipients are returned by the API.

Use instrumentType to get only recipients with the specific payment instrument.

Request

Path Parameters

customerId stringrequired

Customer Id.

Query Parameters

limit integer

Possible values: >= 1 and <= 50

Default value: 10

This is the requested number of records to return. Max = 50. Default = 10.

offset integer

Default value: 0

This is the requested starting position of the response entries, where 0 is the first record. Default = 0.

status WithdrawalRecipientStatus

Possible values: [ACTIVE, INACTIVE]

Recipient status. If not specified only ACTIVE recipients are returned.

instrumentType RecipientInstrumentType

Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT]

Recipient instrument type. If not specified should return all .

Responses

200

OK

application/json

Schema

Schema

recipients object[]

List of Withdrawal recipients.

meta

object

Contains paging information regarding the returned records, when response is paginated.

The input for paginated query contains two parameters:

• limit - This is the requested number of records to return. Defaults to 10 and maximum is 50.
• offset - This is the requested starting position of the response, where 0 is the first record. Default = 0.

Note! The total number of records is not returned, to prevent queries spanning on all records. If numberOfRecords<limit, this means no further pages are available. On request of offset beyond the last record, the returned numberOfRecords is 0.

The number of previous pages can be calculated by dividing offset to limit.

numberOfRecords integer

This is the number of records returned in the lookup. Always numberOfRecords is smaller than or equal to limit.

limit integer

This is the requested number of records to be returned per page.

offset integer

This is the requested starting position of the response, where 0 is the first record.

page integer

This is the page of records on which the lookup starts. The starting page is 1.

Example (from schema)

{
  "recipients": [
    {
      "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"
    }
  ],
  "meta": {
    "numberOfRecords": 1,
    "limit": 10,
    "offset": 0,
    "page": 1
  }
}

GET_ACTIVE_RECIPIENTS

{
  "recipients": [
    {
      "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"
    }
  ],
  "meta": {
    "numberOfRecords": 1,
    "limit": 10,
    "offset": 0,
    "page": 1
  }
}

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...