Skip to content

Create payout

POST api/v2/paygate/payout/wallet/
Create a payout by wallet

Request Body schema

application/json

Field Type Required Description Example
endpoint string Yes Api key "1dc4441f-38d5-42b5-a705-81958f928462"
amount integer Yes Amount in minor units 1000
currency integer Yes Number code 188
buyer object Yes Buyer at the endpoint in JSON format {"remote_id": "string", "ip": "string"}
description string No Description "string"
client_id string No Transaction id at the endpoint.
Max 255 chars
"string"
notify_url string or null No Notification URL of changed status "http://example.com"
moderated boolean or null No Is payout moderated? Default: True True
payment_method string Yes The method of payment being used for the transaction.
May be: sinpe_movil
"sinpe_movil"
name string Yes The customer's name "John Smith"
email string No The customer's email "user@example.com"
phone string Yes The customer's phone number associated with the Sinpe Movil account. "+50670001883"
account_number string Yes The customer's official identification number assigned by a government authority "12312312312"

Request sample

{
    "endpoint": "1dc4441f-38d5-42b5-a705-81958f928462",
    "amount": 1000,
    "currency": 188,
    "buyer": {
        "remote_id": "string",
        "ip": "string"
    },
    "description": "string",
    "client_id": "string",
    "notify_url": "http://example.com",
    "payment_method": "sinpe_movil",
    "name": "John Smith",
    "email": "user@example.com",
    "phone": "+50670001883",
    "account_number": "12312312312"
}

Response sample


STATUS 201

{
    "tx": {
        "tx": "f17d7f5c-6b4a-47fd-95eb-08086e250473",
        "payout": {},
        "status": "create",
        "currency": {
          "id": 0,
          "title": "CRC",
          "char_code": "CRC",
          "num_code": 188
        },
        "amount": 1000,
        "created_at": "2000-01-01T00:00:00Z",
        "errors": {},
        "parts_tx": [],
        "additional_data": {},
        "endpoint_logo": "string"
    }
}