Create payment

POST/payments

Create a new payment for an order

Request Body

accountId*stringAccount ID for tenant isolation

orderId*stringOrder ID this payment is for

orderNumber*stringHuman-readable order number

amount*numberPayment amount

currency*stringCurrency code (ISO 4217)

paymentType*"online_card" | "online_bank_transfer" | "online_wallet" | "in_person_card" | "in_person_cash" | "bank_transfer" | "cheque"Type of payment

paymentProviderIdstringPayment provider ID (optional - will find by type if not provided)

returnUrlstring (uri)URL to redirect after payment

isPartialPaymentbooleanWhether this is a partial payment

remainingBalancenumberRemaining balance after this payment

metadataobjectCustom metadata

Response

Payment created successfully

Code Samples

No code examples available for this operation.

Try It

Request Body

accountId*Account ID for tenant isolation

orderId*Order ID this payment is for

orderNumber*Human-readable order number

amount*Payment amount

currency*Currency code (ISO 4217)

paymentType*Select...online_cardonline_bank_transferonline_walletin_person_cardin_person_cashbank_transferchequeType of payment

paymentProviderIdPayment provider ID (optional - will find by type if not provided)

returnUrlURL to redirect after payment

isPartialPaymentNot settruefalseWhether this is a partial payment

remainingBalanceRemaining balance after this payment

metadata{ "customerEmail": "customer@example.com" }Custom metadata