v1

latestOpenAPI 3.0.32026-07-248079274.0 KB

Payouts

Create a payee

Create a new payee that will be stored against the customer profile. The response contains a unique payee_id, which can then be used in the Process a Payout request.

post/customers/{customer_id}/payees

Path parameters

customer_idstring uuid required

Unique ID assigned by Acquired.com for the customer.

Headers

Company-Idstring uuid

Unique ID assigned by Acquired.com for your company.

Midstring uuid

Unique ID assigned by Acquired.com connecting to a specific acquiring bank.

Request body

sort_codestring required

The sort code of the customer's bank account.

account_numberstring required

The customer's bank account number.

account_namestring required

The account holder's name, as it appears on their bank account.

Example request

{
  "sort_code": "010203",
  "account_number": "12345678",
  "account_name": "MR E JOHNSON"
}

Response

Created

status'success'

payee_idstring uuid

Unique identifier assigned by Acquired.com for the payee record.

Example response

{
  "status": "success",
  "payee_id": "4ebc5489-7b9f-4324-983e-07d4b2b00035"
}