post
https://api.staging.deliverect.com/pay/channel//payments/request
Purpose
Deliverect Pay's API surfaces an endpoint for channels to request a payment. The endpoint supports two mode types redirect or token
Overview
The format for requesting a payment is outlined as below;
- Channel → Deliverect Pay — the payment request specifies a mode of either
redirectortoken(card data is not transmitted in either case) - Deliverect Pay → Payment Service Provider — a redirect URL is returned or funds are acquired (captured or pre-authorized based on
captureModeofimmediateormanual. - Payment Service Provider → Deliverect Pay → Channel — the channel receives the payment identifier and status
Request a payment using a token
Once a token has been verified by calling the Create Token endpoint this can be used to acquire funds.
Capture modeFund acquisition can be requested in two capture modes:
Mode Behavior immediateCapture the funds instantly (default). manualPre-authorize the funds now; capture them later.
Path parameters
| Parameter | Type | Description |
|---|---|---|
channelLinkId | string | The channel link the payment is requested under. Must match the link used at tokenization. |
Request body
| Field | Description | Type |
|---|---|---|
gatewayProfileId* | Gateway configuration to route the payment through. | string |
mode* | How the payment is funded. | object |
mode.type* | Payment mode. Use token for token-based payments (other modes exist). | string |
mode.tokenId* | The id of a verified token from Create Token | string |
captureMode | immediate (default) or manual. See capture modes above. | string |
amount* | Amount in the currency's minor units (e.g. 1000 = 10.00 USD). | integer |
currency* | ISO 4217 currency code (e.g. USD). | string |
payer* | Details of the paying customer. | object |
payer.name* | The payer's display name. | string |
payer.reference* | Channel-side customer reference — typically the same customerId used at tokenization. | string |
Response body
| Field | Type | Description |
|---|---|---|
paymentId | string | Identifier of the created payment. Use it to reference the payment in subsequent operations (e.g. capture, refund). |
paymentStatus | string | Status of the payment, e.g. authorized. With captureMode: "immediate" funds are captured right away; with manual the payment remains authorized until captured. |