Cash

Use the Pagsmile Payout API to send a cash payout to an individual beneficiary in Azerbaijan. The beneficiary receives the payout in USD.

Endpoint

POST https://sandbox.transfersmile.com/api/payout

Headers

Header	Type	Required	Description
Content-Type	string	Yes	Fixed value: application/json; charset=UTF-8.
AppId	string	Yes	Your 32-character App ID in the Pagsmile Payout platform.
Authorization	string	Yes	Request signature generated using SHA256($sorted_params + $app_key).

Request body

Parameter	Type	Required	Constraints	Description
name	string	Yes	Must contain 2–100 characters and be a valid beneficiary name.	Full name of the beneficiary.
document_type	string	Yes	Fixed value: individual (case-insensitive).	Type of beneficiary receiving the payout.
fee_bear	string	Yes	One of: merchant or beneficiary.	Party responsible for the payout fee.
amount	decimal string	Yes	Minimum: 0.01; maximum: 10000. Up to 2 decimal places.	Payout amount, denominated according to amount_type.
amount_type	string	No	One of: arrival_amount or source_amount. Defaults to arrival_amount.	Specifies whether amount is fixed on the beneficiary side or the merchant funding side.
source_currency	string	Yes	Must be a currency enabled for the merchant. The example uses USD.	Currency used to fund the payout.
arrival_currency	string	Yes	Fixed value: USD.	Currency received by the beneficiary.
notify_url	string	Yes	Must be a valid URL and must not exceed 255 characters.	Merchant endpoint that receives payout status notifications.
custom_code	string	Yes	Must be unique for the merchant and must not exceed 50 characters.	Merchant payout reference.
additional_remark	string	Yes	Must contain 4–40 characters. Only letters, numbers, spaces, and underscores are accepted.	Additional information about the payout.
country	string	Yes	Fixed value: AZE.	ISO 3166-1 alpha-3 country code for Azerbaijan.
method	string	Yes	Fixed value: CASH.	Payout method.
channel	string	Yes	Fixed value: UPT.	Cash payout service used for the transaction.

The beneficiary does not need to provide an account or account_type for this payment method.

Request sample

{
  "amount": "0.05",
  "source_currency": "USD",
  "arrival_currency": "USD",
  "fee_bear": "merchant",
  "name": "Ka********ev",
  "document_type": "individual",
  "custom_code": "custom_code33********",
  "notify_url": "https://merchant.example.com/payout/notify",
  "method": "CASH",
  "channel": "UPT",
  "additional_remark": "from test",
  "country": "AZE"
}

Response sample

{
  "code": 200,
  "msg": "success",
  "time": 1787638339,
  "data": {
    "id": "TS2026********",
    "custom_code": "custom_code33********",
    "arrival_amount": "0.05",
    "arrival_currency": "USD",
    "source_amount": "0.06",
    "source_currency": "USD",
    "status": "IN_PROCESSING"
  }
}

A successful API response means that the payout request has been accepted for processing. Use payout notifications or the payout-status query API to determine the final result.