Capture payment
PATH:
/api/v3/orders/{orderNumber}/captures
PATH PARAMETERS:
orderNumber required | string Order number |
REQUEST BODY SCHEMA:
orderDetails object Order details | |||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||
invoiceNumber | string <= 20 characters Invoice number. The merchant may want to use internal invoice numbers, or let the Riverty generate one at random. This will show up in Riverty's portal. One order may have one or more invoices. | ||||||||||||||||||||||||||||||||||||||||||||||||||
campaignNumber | integer Invoice campaign number. The merchant may link multiple orders to a campaign they are running. | ||||||||||||||||||||||||||||||||||||||||||||||||||
array of shippingDetails Shipping information which includes shipping type, company and tracking ID | |||||||||||||||||||||||||||||||||||||||||||||||||||
Array () [
| |||||||||||||||||||||||||||||||||||||||||||||||||||
parentTransactionReference | string <= 128 characters A unique reference provided to Riverty by a third party (merchant or Payment Service Provider). Identifies an entire order. | ||||||||||||||||||||||||||||||||||||||||||||||||||
transactionReference | string <= 100 characters A unique reference for each transaction (separate for transactions within an order), generated and provided to Riverty by a third party (merchant or Payment Service Provider). It is used to identify transactions during back-end settlement between Core systems and the PSP. | ||||||||||||||||||||||||||||||||||||||||||||||||||
references object References object to provide Riverty additional information. Only to be used if advised by Riverty integration manager. | |||||||||||||||||||||||||||||||||||||||||||||||||||
|
RESPONSES:
RESPONSE SCHEMA:
capturedAmount | number Captured amount |
authorizedAmount | number Authorized amount |
remainingAuthorizedAmount | number If Captured and Authorized amount differ, the remaining sum must also be captured or refunded. |
captureNumber | string <= 50 characters Capture number. This is the Invoice Number from Capture Request. Created by the merchant or Riverty. This number is used later to refund an order |
totalRefundedAmount | number Total refunded amount |
totalCapturedAmount | number Total captured amount |
RESPONSE SCHEMA:
type | string Enum:BusinessErrorTechnicalErrorNotificationMessage Message type |
code | string <= 100 characters Confirmation or error code |
message | string <= 4096 characters Message content |
customerFacingMessage | string <= 4096 characters Message to display to customer |
actionCode | string Enum:UnavailableAskConsumerToConfirmAskConsumerToReEnterDataOfferSecurePaymentMethodsRequiresSsnAskConsumerToIdentify Possible next action to make |
fieldReference | string <= 100 characters Reference to field that caused an error |
Path
/api/v3/orders/{orderNumber}/captures
Request samples
- {
- "orderDetails": { ... } ,
- "invoiceNumber": "string",
- "campaignNumber": 1,
- "shippingDetails": [ { ... } ],
- "parentTransactionReference": "string",
- "transactionReference": "string",
- "references": { ... }
Response samples
- {
- "capturedAmount": 1.00,
- "authorizedAmount": 1.00,
- "remainingAuthorizedAmount": 1.00,
- "captureNumber": "string",
- "totalRefundedAmount": 1.00,
- "totalCapturedAmount": 1.00
- {
- "type": "string",
- "code": "string",
- "message": "string",
- "customerFacingMessage": "string",
- "actionCode": "string",
- "fieldReference": "string"