Return notification
PATH:
/api/v3/orders/{orderNumber}/captures/return-notification
PATH PARAMETERS:
orderNumber required | string Order number |
REQUEST BODY SCHEMA:
captureNumber required | string <= 50 characters Capture number for return. This is the capture number which comes from Capture response | ||||||||||||||||||||||||||||||||||
totalGrossAmount | number Total gross amount of order. Must match the grossUnitPrice * quantity of order items | ||||||||||||||||||||||||||||||||||
array of items Order items to return. Maximum allowed 200 items. | |||||||||||||||||||||||||||||||||||
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. |
RESPONSES:
RESPONSE SCHEMA:
- { }
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/return-notification
Request samples
- {
- "captureNumber": "string",
- "totalGrossAmount": 1.00,
- "items": [ { ... } ],
- "parentTransactionReference": "string",
- "transactionReference": "string"
Response samples
- {
- {
- "type": "string",
- "code": "string",
- "message": "string",
- "customerFacingMessage": "string",
- "actionCode": "string",
- "fieldReference": "string"