Create a payment

Creates a payment from the supplied request payload.

POST 
/v3/:customerCode/payments

Request

Responses

200 OK

OK

201 Created

application/json

payment-created

Payment created

{
  "paymentReference": "247086",
  "uniquePaymentId": "v3-capture-1789805452955",
  "customerCode": "TB18780151",
  "customerName": "Ian Menethil",
  "customerReference": "9935442a-6930-428d-b6eb-fa969522e49a",
  "baseAmount": 1,
  "customerFee": 0,
  "fundsToMerchant": 0,
  "processedAmount": 1,
  "paymentAccount": "*****678",
  "cardType": 4,
  "cardTypeString": "Bank Account",
  "subCardType": 4,
  "subCardTypeString": "Bank Account",
  "processingDate": "2026-09-19T18:10:56",
  "paymentStatus": 3,
  "paymentStatusString": "Successful",
  "settlementDate": "2026-09-23",
  "processorReference": "PR.2420u",
  "isPaymentSettledToMerchant": false,
  "merchantName": "Menethil",
  "merchantCode": "1337",
  "isPaymentRetryScheduled": false,
  "processorRetryCount": 0,
  "isPaymentRecalled": false,
  "isPaymentRefunded": false,
  "paymentType": 1,
  "paymentTypeString": "Charge",
  "isPaymentChargeBacked": false,
  "paymentSource": 58,
  "paymentSourceString": "Cust.Api Payment",
  "hasPendingRefundRequest": false,
  "isPartialRefund": false,
  "refundedAmount": 0,
  "refundedCustomerFeeAmount": 0
}

300 Multiple Choices

application/json

payment-id-resent

Payment id resent

{
  "message": "The Payment unique id already exists."
}