Hosted Checkout payment response
The response includes the parameters passed in the Hosted Checkout payment POST request.
| Parameter | Description | Format | Condition |
|---|---|---|---|
authentication.entityId | The entity for the request. This is the entity ID found in the Peach Payments Dashboard. | AN32 [a-f0-9]{32} | Required |
signature | The signature for the request. | AN64 [a-f0-9]{64} | Required |
currency | The currency code of the payment request's amount. | A3 [A-Z]{3} | Required |
merchantTransactionId | Merchant-provided reference number, should be unique for your transactions. Some receivers require this ID and it is often used for reconciliation. | AN16 [a-zA-Z0-9]{8,16} | Conditional |
result | The unique code that describes the result status of the request. See the Response codes section for more detailed information. | AN11 [0-9.]{2,11} | Required |
amount | The amount of the payment request. The dot is the decimal separator. | N10.N2 [0-9]{1,10}(.[0-9]{2}) ? | Required |
checkoutId | The identifier of the checkout request; used to reference the payment request later. | AN48 [a-zA-Z0-9.-]{32,48 } | Required |
id | The unique identifier of a successful payment; used for refunds. | AN32 [a-f0-9]{32} | Conditional |
paymentType | The payment type for the request. The DB and PA types are supported. | A2 | Required |
timestamp | The timestamp of the response. | date yyyy-MM-dd hh:mm:ss | Required |
resultDetails | A container for name value pairs used for enriching the response with Scan to Pay response details. | name: AN64[a-zA-Z0-9._]{3,64} value: AN2048[\s\S]{0,2048} | Conditional |
customParameters[name] | A name value pair used for sending custom information. | name: AN64[a-zA-Z0-9._]{3,64} value: AN2048[\s\S]{0,2048} | Optional |
Updated 3 months ago