Response Parameters
Response parameters indicate and provide the result to a previously sent request.
| Parameter Name | Type | Description |
|---|---|---|
| Status | String |
Request Status Pending – The transaction has been created and is waiting for the payment to be completed. Successful – The transaction has been created and the payment has been completed. Failed – The transaction cannot be created / The payment cannot be completed. Retry Available – The transaction process can be retried. This usually means that the credit card for the credit card transaction is invalid. When retrying, the merchant can use the same Merchant Order ID. Note that the system will use the same transaction amount for the transaction to be retried. If there are changes in the transaction on the merchant's side, the merchant must use a different Merchant Order ID to be able to create and process a new transaction. |
| Message | String | The status message |
| TransactionId | String | The transactions identity on the VeritasPay system. It will not be provided if you received a failed response. |
| Url | String | What the merchant will do with this field will depend on UrlType. |
| UrlType | String |
Redirect –There will be a redirection to the URL provided. QRCode –The merchant will generate a QR code to the merchant’s page using the URL provided. FormPost –The merchant will generate a form using the POST method to the Url with the fields in the FormData parameter. |
| FormData | Key-Value Pairs | This field is required if the UrlType is FormPost. |
Sample Request
{
"MerchantId": "my_merchant_id",
"Amount": 1000.00,
"Tips": 10.00,
"OrderId": "MYORDER000019283",
"CustomerId": "CustomerID_01",
"Remarks": "",
"Operation": "Pay",
"ReturnUrl": "https://myurl.com/return/20d677a5-1bf9-42c8-839d-cc3d23a4988",
"CallbackUrl": "https://myurl.com/callback/20d677a5-1bf9-42c8-839d-cc3d23a49881",
"Signature": "e4c8087c1398c2cd5a5ad6b03ad3c521",
"Data": "HZ4HmwQNe97onmd6jvqvWrXJp/J1hVpwU838RpU6sq0XThJZ8CJMfZusznXDeU/YvCfMDfdAMVOGarNNmjDopC8iOcDy6+DJz8I+NwmYEFbeIvS+VlAc1cJxZ0pDReyJlTvhqZ82sK5N/LLd2VmcC8mrsBuUddjXau+Z91+ZnMviy7U7kGLWqPTYhAlSP5NSG7pSZXVeBp2QqTnAqq7uKIyQUbgUAqGa6A+cZmKEpE+PeOouByqRkTrJVxBtJCDXp3AI5rCiPJ6nR/hc/Wn7CPG6LMgVVYBKvq6kewCG8dT4kDuSI9aWx/H4gUgzB6pKZZKJBoitQuxyXYVsNAJQEgvDBRjHS10UybkyufoXpTEgp69t0CyH2Ae7ttP05mTCHgN80HfU3jrh1gsD2vGAStKaVQV/j9qIGdlo1WOsm0vXOupvb/G8fEM2r6E5N096D0K2hOnUzU7dpKEZZw1b+g==",
}
Sample Successful Response
{
"transactionId": "5e233cf0-9a85-4e87-b054-423c6b42a2ee",
"status": "Pending",
"message": "Pending",
"url": "https://someurl.com/abc/b10a3f7b-e855-4a45-aca9-3a439d2a70db",
"urlType": "FormPost",
"formData":{
"somekey1": "somevalue1",
"somekey2": "11",
"somekey3": "abc",
}
}
Sample Failed Response
{
"transactionId": "null",
"status": "Failed",
"message": "Duplicate transaction",
"url": "null",
"urlType": "null",
"formData": "null",
}