API Reference
GuidesAPI ReferenceRoadmapGo to DashboardSite >

Get Alias Detail

post
https://api.stage.localpayment.com/api/payment/alias-detail

Check whether a payout alias is active and see the masked owner details before sending a payout. Currently available for Colombia only.

See Verify a Payout Alias for the full response field reference, masking rules, error handling guidance, and an interactive demo.


Body Params
string
enum
required

Country of the alias, in ISO 3166-1 alpha-2 format (not alpha-3, unlike most other Localpayment endpoints). Currently only CO (Colombia) is supported.

Allowed:
string
enum
required

Classification of the alias. Currently only Breb (Colombia's Bre-B instant payment system) is supported.

Allowed:
string
required

The alias to verify (phone number, document, email, merchant code, or alphanumeric key).

Responses

Updated 2 days ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 days ago

Did this page help you?