Create a new customer payment

post/customer-payments

Create a new customer payment to be disbursed to invoices and/or customer's outstanding balance

SecuritybearerAuth
Request
Request Body schema: application/json

New customer payment

customerId
required
integer <int32>

Customer identifier

amountInMajorCurrency
required
number [ 0.01 .. 9999999.99 ]

Amount in major currency (e.g pounds/dollars/euros)

description
string [ 0 .. 255 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Payment description

reference
string [ 0 .. 255 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Payment reference from third party payment system

type
required
string (PaymentMethod)

Payment method

Enum: "CHEQUE" "DIRECT_DEBIT" "CANCELLED_DD" "CREDIT_CARD" "PAYPAL" "BACS" "POST_OFFICE_PAYMENT_CARD" "EZYPAY" "GO_CARDLESS" "GC_INSTANT_BANK_PAYMENTS" "STRIPE" "FINASTRA" "FAST_PAY" "OTHER"
billRunType
string (BillRunType)

Bill run type

Enum: "NORMAL" "ADHOC"
Responses
200

Customer payment created

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples
application/json
{
  • "customerId": 1,
  • "amountInMajorCurrency": 10.5,
  • "description": "string",
  • "reference": "string",
  • "type": "CHEQUE",
  • "billRunType": "NORMAL"
}
Response samples
application/json
{
  • "id": 1,
  • "customerId": 1,
  • "amountInMajorCurrency": 10.5,
  • "resultingCustomerBalance": 10.5,
  • "currencyId": 1,
  • "description": "string",
  • "reference": "string",
  • "type": "CHEQUE",
  • "paymentDate": "2019-08-24",
  • "customerPaymentType": "CUSTOMER",
  • "txnType": "INVOICE_CREATED",
  • "invoiceNumber": "string",
  • "invoiceId": 0,
  • "billRunType": "NORMAL"
}