Payout - 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)

country

string

required

Country :CO

name

string

required

Payee's name

phone

string

required

Payee's phone

email

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

encryptStr

string

required

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

Example

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/payout' \
--header 'Authorization;' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw ''

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 (payout的返回data模型)

required

Specific response content

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

email

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

Example

{
  "code": 200,
  "message": "string",
  "data": {
    "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"
  }
}