MXN SPEI Payout list

Get a list of your payouts:

GET /v1/payouts/
Host: query-ap.sulpayments.ch
Content-Type: application/json
Authorization: "<token>"

{
  "from": "2025-08-29 12:00:00",
  "to": "2025-08-30 23:35:59",
  "status": "paid",
  "payment_method": "mxn_spei",
  "sort": "paid_at",
  "direction": "desc",
  "page": 1,
  "per_page": 40
}

Param descriptions

Param	Mandatory	Values	Default
from	false	YYYY-MM-DD or YYYY-MM-DD HH:MM:SS (Timezone is -03:00)	Today at 00:00:00 -03:00
to	false	YYYY-MM-DD or YYYY-MM-DD HH:MM:SS (Timezone is -03:00)	Today at 23:59:59 -03:00
status	false	waiting_payment, canceled, reversed, paid, chargeback, expired, analysis, initial	All
payment_method	true	msxn_spei	All
sort	false	paid_at, compensated_at, reversed_at, created_at, chargeback_at (defaults according to status.)	created_at
direction	false	desc or asc	desc
page	false	Any integer >= 1	1
per_page	false	Any integer >= 1	Maximum is 200

The response will be a list of payouts with the following format:

{
  "payouts": [
    {
      "id": 14,
      "partner_code": "123e4567-e89b-12d3-a456-426614174000",
      "value": 400.45,
      "fee": 1.0,
      "tax": 8.01,
      "payment_type": "transfer",
      "kind": "personal",
      "total": 391.44,
      "status": "done",
      "reason": "",
      "fee_payer": "merchant",
      "claimed_at": "2025-02-05T20:49:34Z",
      "paid_at": "2025-02-05T20:49:56Z"
    },
    {
      "id": 12,
      "partner_code": "f0010c7c-b886-459f-89ed-2982c9016c3c",
      "value": 303.75,
      "fee": 1.0,
      "tax": 6.08,
      "payment_type": "transfer",
      "kind": "personal",
      "total": 296.67,
      "status": "done",
      "reason": "",
      "fee_payer": "merchant",
      "claimed_at": "2025-02-05T20:41:14Z",
      "paid_at": "2025-02-05T20:47:04Z"
    }
  ],
  "total_pages": 1,
  "current_page": 1,
  "per_page": 30
}

Response params descriptions

Param	Description	Value Type
id	Payout ID into the Sulpayment’s system	String
partner_code	Payout reference in your system	String
value	Payout amount	Number (decimal)
fee	Sulpayment's fee in the order in BRL	Number (decimal)
tax	Sulpayment's tax in the order in BRL	Number (decimal)
payment_type	Transfer	String
kind	Kind of the customer (personal or business)	String
total	Total amount paid to the customer	Number (decimal)
status.	Payout current status	String
reason	Reason in case of errors/denials	String
fee_payer	Who will pay the fee. (merchant or customer)	String
claimed_at	Payout’s creation Timestamp	Timestamp
paid_at	Payout’s paid Timestamp	Timestamp

• When checking the status of orders, please note that paid orders may still be modified unless the “Final” field is set to true.