Sign in

v1

latestOpenAPI 3.1.0MIT2026-08-0659118508.8 KB
Out Payment

Lists out payments

Full report with all the out payments from your Account Id

Required scope: <code style="background:#e8f0fe;color:#1a73e8;padding:2px 8px;border-radius:12px;font-size:0.85em">out_payment:read</code>

get/out_payment

Query parameters

pageinteger
Example:1

Specifies the page number of the results to retrieve. This parameter is used for paginating through a collection of records, allowing the client to navigate to different pages of the dataset. The value must be a positive integer (e.g., "1" for the first page).

records_per_pageinteger
Example:20

Specifies the number of records to retrieve per page. This parameter is used for controlling the size of each page in a paginated collection of records. The value must be a positive integer, determining how many records are displayed on each page (e.g., "20" for 20 records per page).

method'transfer' | 'mb'

Filter by method used in the transaction.

type'normal' | 'instant'

Filter by type of out payment.

idstring uuid
Example:bb3e7e60-20f3-4208-9b21-64c635a51f42

Filter by the unique identifier for the resource. Typically formatted as a UUID (Universally Unique Identifier).

keystring
Example:01J32EESEC1Z543P7J3PKSF1Q9

A user-defined identifier used to filter the results. This parameter allows the client to specify a key to retrieve records or transactions that match the provided key. The value is a string and may not be unique, as it is determined by the user.

valuenumber double
Example:10.32

Filter records by the exact transaction amount.

created_atstring
Example:interval(2006-01-02 15:04,2006-01-02 15:04)

Filter records by creation datetime interval in UTC. Maximum allowed range is 30 days. Format: interval(YYYY-MM-DD HH:MM,YYYY-MM-DD HH:MM).

Response

OK

Example response

{
  "data": [
    {
      "schedule_at": "2022-09-15 20:28:58",
      "transactions": {
        "id": "4fb3ac57-c7fe-4157-aeb7-4362ae24deec",
        "key": "01J1PKR2RPHJNJQGFWGDYXY0KM",
        "created_at": "2025-05-30T17:21:47Z",
        "date": "2025-05-30T17:21:46Z",
        "values": {
          "requested": 12.55,
          "paid": 12.55,
          "fixed_fee": 0.07,
          "variable_fee": 0.09,
          "tax": 0.04,
          "transfer": 12.35
        },
        "transfer_date": "2025-06-02T00:00:00Z",
        "transfer_batch": "584",
        "method": "transfer",
        "document_number": "MARCEL0208220628294020250530172147",
        "descriptive": "blue t-shirts"
      },
      "created_at": "2022-09-15 20:28:58",
      "timestamp": "1749054192"
    }
  ]
}