Consult | API Cashout Redes

Name

Required

Description

Type

Length

otp

Yes

One time password (OTP)

Alphanumeric

30

netcode

Yes

Network code (convenio)

Numeric

20

document

Yes

ID or reference associated with the operation (Max 20 characters)

Alphanumeric

20

checksum

Yes

Checksum encoded with SHA512 (name + pin + document + FIXED_HASH)

Alphanumeric

512

customparam01

Yes

Custom param (account type)

Alphanumeric

50

customparam02

Yes

Custom param (amount)

Alphanumeric

50

customparam03

Yes

Custom param

Alphanumeric

50

curl --request POST 'https://api-test.payvalida.com/cashout/v1/order/VIA' --data-raw '{
"otp": "1234056",
"netcode": 180,
"document": "1020304051",
"checksum": "SHA512FIXEDHASH"
}'

Name

Description

Type

code

Indicates the resulting code, “0000” means result with no error, any other value indicates the error code.

Alphanumeric

text

Contains the detailed message associated with the code.

Alphanumeric

data

Contains the transaction’s data (when there’s no error)

Object

data-amount

Amount of the transaction

Alphanumeric

data-transactionCost

Cost assumed by the user for this transaction

Alphanumeric

data-currency

Currency registered for this cashout order*

Alphanumeric

data-document

Confirmation of the document ID

Alphanumeric

data-otp

Confirmation of the sent OTP

Alphanumeric

data-operation

Identifier of the operation, required to register the transaction

Alphanumeric

data-customparam01

Custom parameter sent by the network

Alphanumeric

data-customparam02

Custom parameter sent by the network

Alphanumeric

data-customparam03

Custom parameter sent by the network

Alphanumeric

data-checksum

Checksum encoded with SHA512(pin + document + amount + currency + idoperation + FIXED_HASH)

Alphanumeric

{
"code": "0000",
"text": "OK",
"data": {
"amount": "31529.0",
"transactionCost": "991",
"currency": "COP",
"description": "Test Cashout",
"document": "10410754367",
"otp": "3659",
"operation": "312",
"checksum": "SHA512FIXEDHASH"
}
}