Create Payout

Request URL

method	url
POST	/api/pay/payout/create/v1

Header Information

Header Parameter	Description
timestamp	Request timestamp
nonce	Random value
country	Country code (e.g., BR)
appCode	Application ID

Request Parameters

Field	Type	Required	Length	Description
merchantOrderNo	String	Yes	32	Merchant order number
amount	String	Yes	20	Payout amount (in Brazilian Real), up to 2 decimal places
bankCode	String	no	50	Bank code
bankName	String	No	50	Bank name
accountType	Int	Yes		CPF-401 CNPJ-402 PHONE-403 EMAIL-404 EVP-405 Choose one of these parameters based on actual situation
bankAccount	String	Yes	255	Payout bank account
realName	String	Yes	255	User’s real name
idCardNumber	String	Yes	50	Payer’s ID card number
idType	String	Yes	32	CPF (11 digits), CNPJ (14 digits)
callbackUrl	String	No	200	Payout callback URL, if not provided, the merchant configuration will be used
sign	String	Yes		Signature

{
    "merchantOrderNo": "OrderNoExample",
    "realName": "TeemoPay",
    "bankCode": "1",
    "bankName": "BANK",
    "accountType": 101,
    "bankAccount": "1234567890123456",
    "amount": "100000",
    "callbackUrl": "https://www.callbackexample.com",
    "sign": "YOUR_SIGN",
    "idType": "DNI",
    "phone": "11987654321",
    "idCardNumber": "12345678"
}

Response Parameters

Parameter	Type	Required	Length	Description
merchantOrderNo	String	yes	32	Merchant order number
tradeNo	String	yes		Platform order number
status	Int	yes		Reimbursement status 【1: Payment in progress 3: Failure (can be re-initiated)】
amount	String	yes		Transaction amount

Response

{
  "merchantOrderNo": "OrderNoExample",
  "tradeNo": "TF2501010001BR0000000000000000",
  "status": 1,
  "sign": "TEEMO_SIGN"
}