Payin by Cash - TwoPay

Request

Header Params

Authorization

string

required

token (obtained through co/v1/oauth2/token)
Format: Bearer+" "+ tokens

x-api-key

string

required

We will provide relevant data in the email

Body Params application/json

uniqueKey

string

required

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

name

string

required

Payer's name

phone

string

required

Payer's phone

email

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

Example

{
    "uniqueKey": "string",
    "name": "string",
    "phone": "string",
    "email": "string",
    "document": "string",
    "documentType": "string",
    "amount": "string",
    "address": "string",
    "remarks": "string",
    "encryptStr": "string",
    "cashCode": "string"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'http://test-cn.your-api-server.com/co/v1/payment/cash' \
--header 'Authorization;' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "uniqueKey": "string",
    "name": "string",
    "phone": "string",
    "email": "string",
    "document": "string",
    "documentType": "string",
    "amount": "string",
    "address": "string",
    "remarks": "string",
    "encryptStr": "string",
    "cashCode": "string"
}'

Responses

🟢200response

application/json

Body

code

enum<integer> <int32>

required

code: 200, request success 401,request fail

Allowed values:

200401

Default:

200

Example:

200

message

string

required

When the response code is 200, the content is "SUCCESS" If the response code is not 200, an error message is displayed

data

object

required

Specific response content

uniqueKey

string

required

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

name

string

required

Payer's name

phone

string

required

Payer's phone

email

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

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

{
    "code": 200,
    "message": "string",
    "data": {
        "uniqueKey": "string",
        "name": "string",
        "phone": "string",
        "email": "string",
        "document": "string",
        "documentType": "string",
        "amount": "string",
        "address": "string",
        "remarks": "string",
        "encryptStr": "string",
        "cashCode": "string",
        "numeroConvenio": "string",
        "referenceNumber": "string",
        "status": "string"
    }
}