Payin Notification

Developing

POST

/PayinNotification

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

uniqueKey

string

required

Unique identification ID of the transaction (each request must be guaranteed to be different)

bankCode

string

required

PSE bank code

name

string

required

Payer's name

phone

string

required

Payer's phone

string

required

Payer's email

document

string

required

Payer's document number

documentType

string

required

Payer's document type:CC CE NIT

amount

string

required

amount

address

string

required

Payer's address

remarks

string

required

remarks

encryptStr

string

required

(uniqueKey+document+amount) encrypted string, encrypted salt is provided by us

cashCode

string

required

Bancolombia EFECTY SURED

pseUrl

string

required

Once this field is obtained, you need to redirect the buyer to the URL to complete the transaction at the appropriate financial institution (this field has a value when it is PSE's repayment status query)

numeroConvenio

string

required

numeroConvenio

referenceNumber

string

required

referenceNumber

status

string

required

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

Example

{
    "uniqueKey": "string",
    "bankCode": "string",
    "name": "string",
    "phone": "string",
    "email": "string",
    "document": "string",
    "documentType": "string",
    "amount": "string",
    "address": "string",
    "remarks": "string",
    "encryptStr": "string",
    "cashCode": "string",
    "pseUrl": "string",
    "numeroConvenio": "string",
    "referenceNumber": "string",
    "status": "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/PayinNotification' \
--header 'Content-Type: application/json' \
--data-raw '{
    "uniqueKey": "string",
    "bankCode": "string",
    "name": "string",
    "phone": "string",
    "email": "string",
    "document": "string",
    "documentType": "string",
    "amount": "string",
    "address": "string",
    "remarks": "string",
    "encryptStr": "string",
    "cashCode": "string",
    "pseUrl": "string",
    "numeroConvenio": "string",
    "referenceNumber": "string",
    "status": "string"
}'

Responses

🟢200response

application/json

Body

object {0}

Example

{}

Modified at 2023-05-11 08:02:16

Payin status check

Payout balance check