Payouts

List fiat payout statuses

Changed on

Returns fiat payouts owned by the authenticated organization whose creation time falls within the inclusive start_time and end_time range. Requires payout.read permission.

Results are ordered by creation time descending and use page-based pagination. page defaults to 1; page_size defaults to 20 and cannot exceed 100.

Use this endpoint for periodic time-window reconciliation. Use GET /v2/payouts/{payout_id} when retrieving one known payout.

post/v2/payouts/status/batch

Request

Headers

X-API-Key-IDstring required

32-character Base58 credential ID returned after public-key registration.

X-API-Timestampstring required

Unix timestamp in seconds; tolerance is ±300 seconds.

X-API-Noncestring required

16 cryptographically random bytes encoded as unpadded Base64URL; fresh on every attempt.

Digeststring required

SHA-256= followed by standard padded Base64 of SHA-256 of exact request body bytes. Required even for an empty body; included in the signing string.

Authorizationstring required

Use Ed25519 signature="BASE64_SIGNATURE", where BASE64_SIGNATURE is the standard padded Base64 signature. See /docs/en/4-authorization for the exact signing string.

Request body

start_timeinteger required

Inclusive payout creation start time as Unix seconds.

end_timeinteger required

Inclusive payout creation end time as Unix seconds. Must be greater than or equal to start_time.

pageinteger

Page number.

page_sizeinteger

Number of payouts per page.

Example request

{
  "start_time": 1786500000,
  "end_time": 1786599999,
  "page": 1,
  "page_size": 20
}

Response

Payout statuses in creation-time descending order with pagination

code0 required

Business code. 0 means success.

messagestring required

Response message.

Example response

{
  "data": {
    "payouts": [
      {
        "payout_id": "fpo_01JQ90GQJTC5P7B2D8N6R4K1MX",
        "client_reference_id": "payout_20260730_0001",
        "quote_id": "poq_01JQ90B8S5VJ6R3T7F1M2C4N9X",
        "provider": "sgb",
        "status": "completed",
        "payout_type": "swift",
        "source_currency": "USD",
        "destination_currency": "USD",
        "destination_country": "US",
        "amount_mode": "receive",
        "fee_paid_by": "PAYER",
        "sending_amount": "1051.05",
        "receiving_amount": "1000.00",
        "transfer_fee_amount": "1.05",
        "bank_fee_amount": "50.00",
        "fee_rate_decimal": "0.001",
        "rate": "1",
        "billing": {
          "currency": "USD",
          "transfer_fee": "1.05",
          "fx_fee": "0.00",
          "rail_fee": "50.00",
          "total_fee": "51.05",
          "fee_lines": [
            {
              "type": "transfer_fee",
              "amount": "1.05",
              "currency": "USD",
              "rate": "0.001"
            }
          ]
        },
        "destination": {
          "type": "bank_account",
          "account_holder_type": "business",
          "account_holder_name": "Acme Supplies LLC",
          "bank_country": "US",
          "bank_name": "Example Bank",
          "account_number_masked": "******3210",
          "swift_code": "BOFAUS3NXXX"
        },
        "purpose_code": "goods_and_services",
        "statement_reference": "INV-2026-0730",
        "bank_reference": "RMTO2084957259539812352",
        "failure": {
          "code": "payout_failed",
          "message": "The payout could not be completed"
        },
        "return": {
          "status": "refunded",
          "reason_code": "recipient_bank_rejected",
          "reason": "Beneficiary bank rejected the transfer",
          "returned_amount": "1000.00",
          "refund_amount": "1000.00",
          "retained_fee": "51.05",
          "currency": "USD",
          "returned_at": 1786674271
        },
        "created_at": 1786587000,
        "updated_at": 1786587871,
        "completed_at": 1786587871
      }
    ],
    "total": 1,
    "page": 1,
    "page_size": 20,
    "total_pages": 1
  }
}

Changes

    • breaking

      added the new required header request parameter X-API-Key-ID

    • breaking

      added the new required header request parameter X-API-Nonce

    • breaking

      added the new required header request parameter X-API-Timestamp

    • breaking

      the header request parameter Authorization became required

    • breaking

      the header request parameter Digest became required

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • warning

      deleted the header request parameter Date

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      the /// response's property type changed from no type to object for status

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      removed from the /// response property oneOf list for the response status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status