Skip to content

Payout API ​

Overview ​

The payout API creates a payout order to make payments. Merchants can send payments to users, supporting bank and e-wallet accounts.

API Info ​

  • Endpoint: POST /api/ar/payout
  • Method: POST
  • Content-Type: application/json

Request Headers ​

All API requests require the following headers, see API Signature:

HeaderTypeRequiredDescription
Content-TypestringYapplication/json, fixed
MerchantIdstringYMerchant ID provided by Veloraya
TimestampstringYCurrent timestamp (ms), anti-replay
NoncestringYRandom string, unique per request, anti-replay
SignaturestringYRequest signature (RSA), Base64 encoded

Request Parameters ​

ParameterTypeRequiredDescription
merchantOrderIdstringYMerchant order ID, unique
amountBigDecimalYOrder amount
currencystringYCurrency code, fixed ARS
accountTypestringYAccount type, see enum
payeeAccountNostringYBeneficiary account number
payeeNamestringNBeneficiary name, 1-128 chars
payeeLastNamestringNBeneficiary last name, 1-128 chars
payeeFullNamestringNBeneficiary full name (either this or name/lastName required)
payeeIdTypestringYBeneficiary ID type, see enum
payeeIdCardstringYBeneficiary ID number
payeeMobilestringYBeneficiary mobile
payeeEmailstringYBeneficiary email (must be valid format)

Account type enum ​

ValueDescription
CVUCVU account
CBUCBU account

ID type enum ​

ValueDescription
CUITArgentine Tax ID (preferred)

Request Example ​

json
{
  "merchantOrderId": "Order33666279",
  "amount": 5100,
  "currency": "ARS",
  "accountType": "CVU",
  "payeeName": "Beneficiary Name",
  "payeeAccountNo": "8692634925111",
  "payeeIdType": "DNI",
  "payeeIdCard": "2071871354",
  "payeeMobile": "13851585444",
  "payeeEmail": "test@gmail.com"
}

Response Format ​

FieldTypeDescription
codeint200 success, 500 failure
msgstringResponse message
dataobjectResponse data, order info on success

Response Parameters (data) ​

FieldTypeDescription
merchantIdstringMerchant ID
orderIdstringPlatform order ID
merchantOrderIdstringMerchant order ID
orderStatusstringPENDING-Processing, FAILED-Failed
amountBigDecimalOrder amount
currencystringCurrency code, default ARS
feeBigDecimalTransaction fee
errorCodestringError code (on failure)
errorMsgstringError description (on failure)
createDatetimestringOrder create time
completionDatetimestringCompletion time (null if not complete)

Order status enum ​

ValueDescription
PENDINGPending
FAILEDFailed

Response Example ​

Success ​

json
{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "merchantId": "602255",
    "orderId": "PAYOUT2059898253450452992",
    "merchantOrderId": "Order33666279",
    "orderStatus": "PENDING",
    "amount": 5100,
    "currency": "ARS",
    "fee": 51.00,
    "errorCode": null,
    "errorMsg": null,
    "createDatetime": "2026-05-28 14:23:09",
    "completionDatetime": null
  }
}

Error Codes ​

See Error Codes for the full list.

Notes ​

  1. Headers: all required headers must be passed, see API Signature
  2. Signature: all requests must include a valid signature (verified by gateway filter)
  3. Async notification: order status changes are notified via Payout Callback (merchant must configure notify URL)
  4. Idempotency: duplicate requests with the same merchant order ID fail; the system does not create duplicate orders
  5. Order status: distinguish HTTP response code (200 = request accepted) from final payout result (data.orderStatus)

Released under the MIT License.