POST
/
v1
/
payout
curl --request POST \
  --url https://sandboxapi.me-cash.com/v1/payout \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "recipient": {
    "name": "Linda Collins",
    "type": "BUSINESS",
    "address": "200 Koch Vista, New York, NY 10001",
    "account": {
      "accountNumber": "857362910",
      "sortCode": "CHASUS33XXX",
      "bankName": "Chase Bank",
      "address": "1948 Kemmer Ville, New York, NY 10002",
      "routingNumber": "021000021"
    },
    "paymentChannel": "BANK_TRANSFER",
    "currency": "USD",
    "country": "US",
    "stored": false
  },
  "quoteId": "859b19e8-8a00-4d59-9970-xxxxxxxxxxxxx",
  "reason": "Gift",
  "remark": "Testing"
}'
{
  "status": "success",
  "message": "Operation completed successfully.",
  "data": {
    "id": "c6611ad3-805a-415b-98b7-xxxxxxxxxxxxx",
    "remark": "Testing",
    "reason": "Gift",
    "referenceNumber": "L2TEZEHNXXXXXX",
    "type": "SEND",
    "state": "COMPLETED",
    "quote": {},
    "recipient": {},
    "created": "2023-11-07T05:31:56Z",
    "processed": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
recipient
object
​
quoteId
string
​
reason
string
​
remark
string

Response

200 - application/json

Transaction created successfully.

​
status
string
required
Example:

"success"

​
message
string
required
Example:

"Operation completed successfully."

​
data
object

The payload of the successful response.