Create a payment

Creates a payment from the supplied request payload.

POST 
/v3/:customerCode/payments

Request

Responses

200 OK

OK

201 Created

application/json

sandbox

Real sandbox response

{
  "paymentReference": "246805",
  "uniquePaymentId": "v3-collection-test-001",
  "customerCode": "TR20621497",
  "customerName": "Ian Menethil",
  "customerReference": "v3-collection-test",
  "baseAmount": 1,
  "customerFee": 0.4,
  "fundsToMerchant": 0,
  "processedAmount": 1.4,
  "paymentCard": "555555XXXXXX4444",
  "cardType": 2,
  "cardTypeString": "MasterCard",
  "subCardType": 2,
  "subCardTypeString": "MasterCard",
  "processingDate": "2026-09-16T22:03:34",
  "paymentStatus": 3,
  "paymentStatusString": "Successful",
  "settlementDate": "2026-09-18",
  "processorReference": "7895602138736758003814",
  "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

duplicateId

Real sandbox response

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