v2

latestOpenAPI 3.1.02026-07-267085761.0 MB
Uniteller

Resolve a payer and its validation rules for a country

Resolves a Uniteller payer for the destination country (countryIso, ISO2 e.g. "CL") and currency, returning the payer's rules plus the selected payerId. Send payerId back as international_payer_id on POST /international/payout; the returned mandatory-tag rules are what the payout payload is validated against server-side. Pass branchId (from GET /international/branches) to have that branch's min/max payout amount returned in the rule's min_max_amount.

get/api/v1/international/payer-rules

Query parameters

countryIsostring required
currencystring
branchIdstring nullable

Response

Successful Response

successboolean

Indicates whether the request was processed successfully.

messagestring

A short, human-readable message describing the result of the request.

{"stackTrail":"components:schemas:CommonResponse:properties:data:anyOf","oasType":"schema","type":"unknown","title":"Data","description":"The main response payload, if applicable","nullable":true}
queryGeneratedTimenumber nullable

The Unix timestamp (in seconds) indicating when the response was generated.

Example response

{
  "success": true,
  "message": "Operation completed.",
  "queryGeneratedTime": 1718006400
}