Notification fields
FIELD | DATATYPE | REQUEST | RESPONSE | SIZE | DESCRIPTION |
---|---|---|---|---|---|
orderId | String | - | (M) | 36 | The unique identifier of the order this notification refers to. Format UUID. |
transactionId | String | - | (M) | 36 | The unique identifier of the transaction this notification refers to. In chargeback notifications, this is the ID of the original payment transaction. Format UUID. |
transactionType | String | - | (M) | 10 | The transaction type, being the possible values payment, refund, chargeback or rdr. |
transactionStatus | String | - | (M) | 10 | The current status of a transaction. The transaction will start in_process and change to success, failed, in_process or waiting_user_interaction for asynchronous / 3DS payments. |
notificationDate | Instant | - | (M) | 20 | Notification time in UTC. Format: ISO 8601 in UTC / YYYY-MM-DDTHH:mm:ssZ. |
money.amount | BigDecimal | - | (M) | 38 | The amount of the transaction this notification refers to. The amount of the decimal place depends on the currency. |
money.currency | String | - | (M) | 3 | The currency of the transaction this notification refers to. Format: 3-character abbreviation according to ISO 4217. |
chargebackInfo. reasonCode | String | - | (O) | 20 | Chargeback reason code, only in case the notification type is chargeback. |
chargebackInfo. category | String | - | (O) | 100 | Chargeback category, only in case the notification type is chargeback. |
chargebackInfo. description | String | - | (O) | 400 | Chargeback description, only in case the notification type is chargeback. |
action.url | String | - | (O) | The URL to continue the 3DS process and provided by the access server control. It’s necessary to redirect the user to this to realize the required steps to the 3DS challenge. | |
action.method | String | - | (O) | 7 | The required HTTP method to apply to the URL to redirect the user and continue the 3DS process. |
action.headers | Array (Object) | - | (O) | - | The array of key and value for the request headers. It is necessary for some redirection that providers need for 3DS challenge, e.g.: "headers": \[ {"key": "authReq","value": "ABC"}, {"key": "headerReq",“value": "XYZ"} \] |
action.parameters | Array (Object) | - | (O) | - | The array of key and value for the request parameters. IIt is necessary for some redirection that providers need for 3DS challenge, e.g.: "parameters": \[ {"key": "connector","value": "3DS"}, {"key": "PaReq",“value": "XYZ"} \] |
errorMessage | String | - | (O) | Unlimited (BD 400KB) | Error message from the provider. |