Developer Docs
WebsiteDashboard
GuidesAPI ReferenceHelp
Business CollectionOn-Ramp

Retrieve a receive account

GET
/openapi/v1/collections/on-ramp/receive-accounts/{payerId}

Retrieve the opening status and CLABE of a payer's receive account. The response structure is the same as the Open a receive account response.

You can only retrieve payers of your own merchant account. A payerId that has never been opened returns "receive account not found".

Authorization

bearerAuth
headerAuthorizationBearer <token>

The access_token obtained from POST /oauth2/token. Header format: Authorization: Bearer {accessToken}. The merchant identity comes from the token. The request body does not accept merchant or tenant fields.

Path Parameters

payerId*string

The payerId used to open the account

Query Parameters

fiatCurrency*"MXN"

Fixed to MXN

Value in"MXN"

Response Body

Returns the receive account.

application/json
  1. response
code?integer

Business status code

message?string
traceId?string

Request trace ID. Provide it when you contact technical support

data?

Payer's receive account. Opening and retrieving a receive account use the same structure.

Example Request
curl -X GET 'https://api.test.stabofx.com/openapi/v1/collections/on-ramp/receive-accounts/payer-0001?fiatCurrency=MXN'
Example Response
{  "code": 200,  "message": "OK",  "traceId": "trace-uuid-string",  "data": {    "payerId": "payer-0001",    "fiatCurrency": "MXN",    "paymentMethod": "SPEI",    "status": "ACTIVE",    "clabe": "706180000000000001"  }}

Open a receive account POST

Open a dedicated receiving CLABE for a payer. Opening takes a few minutes. Call this endpoint when the payer registers or is linked. Do not wait until payment time to open the account. This endpoint is idempotent. Repeated calls with the same `payerId` return the current status of the same receive account and do not open another account. `Idempotency-Key` is not required. Opening an account does not require payer KYC. You submit KYC when you create an order. This release does not push notifications for opening results. Use the Retrieve a receive account endpoint, and wait at least 1 minute between requests. The receive account does not expire. All future orders for the same payer use this CLABE.

Get a quote GET

Get a reference price. A quote does not lock the price. The final price is the one in the order creation response. Quotes support MXN amounts only. You can create an order by MXN (`fiatAmount`) or USDT (`cryptoAmount`) amount. A quote does not generate a quote ID. You do not need to pass quote information when you create an order.