Skip to main content
POST
Create an entitled platform-to-merchant transfer

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required
Required string length: 8 - 255

Body

application/json
amount_minor
integer
required
Required range: x >= 1
purpose
enum<string>
required
Available options:
merchant_incentive,
platform_top_up
currency
enum<string>
Available options:
MXN
description
string
Required string length: 1 - 160

Response

200 - application/json

Reserved and submitted transfer without provider identifiers.

amount_minor
string
required
Pattern: ^[1-9][0-9]*$
completed_at
string<date-time> | null
required
created_at
string<date-time>
required
currency
any
required
description
string | null
required
Maximum string length: 160
failure_code
string | null
required
id
string
required
Pattern: ^sptr_[a-z0-9]{32}$
object
any
required
purpose
enum<string>
required
Available options:
merchant_incentive,
platform_top_up
reversed_amount_minor
string
required
Pattern: ^[0-9]+$
status
enum<string>
required
Available options:
failed,
partially_reversed,
provider_pending,
reconciliation_required,
reversed,
succeeded
Last modified on September 1, 2026