Payout Notification

Developing

POST

/PayoutNotification

The address of this interface is provided by you. We will call this interface periodically to notify you of the change of transaction status

Request

Body Params application/json

status

string

required

Transaction status "SUCCESS" : The transaction succeeds FAILED: The transaction failed IN_PROGRESS: in process

uniqueKey

string

required

uniqueKey

country

string

required

Country :CO

name

string

required

Payee's name

phone

string

required

Payee's phone

string

required

Payee's email

document

string

required

Payee's document number

documentType

string

required

Payee's document type:CC CE NIT

bankCode

string

required

bank code

bankType

string

required

bank type :1 savings,2 credit cards

bankAccount

string

required

Payee's bank account

amount

string

required

amount

remarks

string

required

remarks

address

string

required

Payee's address

errorMessage

string

required

Error message

errorCode

string

required

Error code

Example

{
    "status": "string",
    "uniqueKey": "string",
    "country": "string",
    "name": "string",
    "phone": "string",
    "email": "string",
    "document": "string",
    "documentType": "string",
    "bankCode": "string",
    "bankType": "string",
    "bankAccount": "string",
    "amount": "string",
    "remarks": "string",
    "address": "string",
    "errorMessage": "string",
    "errorCode": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://test-cn.your-api-server.com/PayoutNotification' \
--header 'Content-Type: application/json' \
--data-raw '{
    "status": "string",
    "uniqueKey": "string",
    "country": "string",
    "name": "string",
    "phone": "string",
    "email": "string",
    "document": "string",
    "documentType": "string",
    "bankCode": "string",
    "bankType": "string",
    "bankAccount": "string",
    "amount": "string",
    "remarks": "string",
    "address": "string",
    "errorMessage": "string",
    "errorCode": "string"
}'

Responses

🟢200response

application/json

Body

isSuccess

enum<string>

required

1 mean success

Allowed value:

Example

{
    "isSuccess": "1"
}

Modified at 2023-05-11 07:25:30

Payout status check

Get PSE Bank