Notification
The notification message will be sent to your Notification URL using POST protocol whenever payment status is changed.
{
"statusCode": 200,
"errorMsg": "",
"idempotencyKey": "idempotency-key",
"targetName": "Test Name",
"targetDocument": "0000000",
"targetBankCode": "1000",
"targetBankAccountId": "0000000001",
"amountInCents": 100000,
"currency": "COP",
"createTime": "2022-10-10 08:36:36 GMT+00:00",
"finalStatusTime": "2022-10-10 08:37:13 GMT+00:00",
"transferStatus": "SETTLED",
"transferStatusCode": 200,
"transferErrorMsg": "",
"subMerchantId": "UUID"
}
Parameters¶
| Parameter | Type | Description |
|---|---|---|
| statusCode | Integer | 200 Success |
| errorMsg | String | Error message if failed |
| idempotencyKey | String | Unique key to ensure idempotent requests |
| targetName | String | Target account holder full name |
| targetDocument | String | Target account holder identity |
| targetBankCode | String | Target Bank Code. |
| targetBankAccountId | String | Target Bank Account Id. |
| amountInCents | Long | The transfer amount. note: 100 = 1COP |
| currency | String | The currency code of the transferred fund. enum value as COP |
| createTime | String | Payment record create time |
| finalStatusTime | String | Transfer final status update time, final status include SETTLED and REJECTED |
| transferStatus | String | Transfer status, SETTLED and REJECTED, We should use transferStatus to judge the payment status |
| transferStatusCode | Integer | Transfer status code, TransferErrorCode |
| transferErrorMsg | String | Transfer error message if failed |
| subMerchantId | String | The sub merchant ID |