Create a cashout

Generate cashout request

post

This endpoint allows generating withdrawal requests (cashouts)

Header parameters

Content-TypestringRequired

Request content type

Default: application/json

Payload-SignaturestringRequired

Control signature to verify the authenticity of the request

Example: HmacSHA256-encoded signature

Body

application/json

loginstringRequired

Your access key for the onekeypayments CASHOUTS API

passstringRequired

Your password key for the onekeypayments CASHOUTS API

external_idstringRequired

Unique cashout ID on the merchant side

countrystringRequired

Country of the cashout

amountnumberRequired

Cashout amount

currencystringOptional

Currency in which the amount is specified

document_idstringRequired

Beneficiary's document ID

document_typestringOptional

Specified identity document type

beneficiary_idstringOptional

Beneficiary ID (for anonymous)

beneficiary_namestringRequired

Beneficiary's name

beneficiary_lastnamestringOptional

Beneficiary's last name

emailstringOptional

Beneficiary's email address

phonestringOptional

Beneficiary's phone number

bank_codenumberOptional

Beneficiary's bank code

bank_accountstringOptional

Beneficiary's bank account

bank_branchstringOptional

Bank branch of the beneficiary's account

account_typestringOptional

Beneficiary's account type

addressstringOptional

Beneficiary's address

citystringOptional

Beneficiary's city

postal_codestringOptional

Beneficiary's postal code

beneficiary_birthdatestringOptional

Beneficiary's date of birth

notification_urlstringRequired

URL where notifications will be sent

commentsstringOptional

Comments about the cashout

on_holdbooleanOptional

Marks a cashout as on hold and does not process it until manually changed to pending

typestringOptional

Response format type

Responses

200

Cashout request successfully created

application/json

cashout_idstringOptional

Unique identifier for the generated cashout

Example: 8405147

400

Request error (KYC error)

application/json

401

Authentication error

application/json

412

Data validation error

application/json

post

/cashout

HTTPcURLJavaScriptPython

POST /v3/cashout HTTP/1.1
Host: api-stg.onekeypayments.com
Payload-Signature: text
Content-Type: application/json
Accept: */*
Content-Length: 308

{
  "login": "xxxxxxx",
  "pass": "xxxxxxx",
  "external_id": "30000000001",
  "country": "BR",
  "currency": "BRL",
  "amount": 100,
  "document_id": "01716001340",
  "beneficiary_name": "User",
  "bank_account": "3423422-7",
  "bank_code": "001",
  "bank_branch": "1234",
  "account_type": "C",
  "notification_url": "https://webhook.site/url",
  "type": "json"
}

{
  "cashout_id": "8405147"
}