Accept Payments
This guide explains the end-to-end payment acceptance flow for an existing checkout.
Setup
Before starting, integrate a gateway as described in Custom Payment Gateway.
Flow
- Create a payment request via Create a payment request.
- Retrieve processor data via Receive processor info.
- Verify/process payment in your gateway implementation.
- Confirm with Confirm a payment request.
Processor payload
Use the processor payload below to map fields into your gateway integration.
Payment processor info
Required attributes
- Name
paymentGatewayType- Type
- enum(stripe, paypal, adyen, custom, cardconnect, worldline, shift4, authorizenet, wallee, square, payfast, touchnet, transact, unzer, monext, vivenuPayments, ebanx, rapyd, additional-payment-method)
- Description
- Name
createdAt- Type
- string
- Description
An ISO timestamp indicating when the payment request processor was created
Optional attributes
- Name
paymentGatewayId- Type
- string
- Description
- Name
reference- Type
- string
- Description
- Name
redirectUrl- Type
- string
- Description
- Name
data- Type
- oneOf
- Description
Example
{
"paymentGatewayType": "stripe",
"createdAt": "2030-01-23T23:00:00.123Z",
"paymentGatewayId": "507f191e810c19729de860ea",
"reference": "string",
"redirectUrl": "https://example.com",
"data": []
}