# Lists out payments

Full report with all the out payments from your Account Id

Endpoint: GET /out_payment
Version: 2.0
Security: accountId, apiKey

## Query parameters:

  - `page` (integer)
    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).
    Example: 1

  - `records_per_page` (integer)
    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).
    Example: 20

  - `method` (string)
    Filter by method used in the transaction.
    Enum: "transfer", "mb"

  - `type` (string)
    Filter by type of out payment.
    Enum: "normal", "instant"

  - `id` (string)
    Filter by the unique identifier for the resource. Typically formatted as a UUID (Universally Unique Identifier).
    Example: "bb3e7e60-20f3-4208-9b21-64c635a51f42"

  - `key` (string)
    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.
    Example: "01J32EESEC1Z543P7J3PKSF1Q9"

  - `value` (number)
    Filter records by the exact transaction amount.
    Example: 10.32

  - `created_at` (string)
    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).
    Example: "interval(2006-01-02 15:04,2006-01-02 15:04)"

## Response 200 fields (application/json):

  - `meta` (object)
    The Pagination object contains detailed information about the pagination of a collection of records.

This object is used to provide navigation and context for paginated results, allowing users to easily move between pages and understand the scope of the dataset.

  - `meta.page` (object, required)
    An object containing information about the pagination of pages within the collection.

  - `meta.page.current` (integer, required)
    The current page number being viewed.

  - `meta.page.total` (integer, required)
    The total number of pages available in the collection.

  - `meta.records` (object, required)
    An object containing information about the records within the collection.

  - `meta.records.total` (integer, required)
    The total number of records available in the collection.

  - `meta.records.per_page` (integer, required)
    The number of records displayed per page.

  - `meta.links` (object)
    An object containing URLs for navigation between different pages of the collection.

  - `meta.links.first` (string)
    The URL to the first page of the collection.

  - `meta.links.prev` (string)
    The URL to the previous page of the collection. This field is an empty string if there is no previous page.

  - `meta.links.next` (string)
    The URL to the next page of the collection. This field is an empty string if there is no next page.

  - `meta.links.last` (string)
    The URL to the last page of the collection.

  - `data` (array)

  - `data.id` (string)
    A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced.

  - `data.status` (string)
    Status of the out payment.
    Enum: "success", "pending", "deleted", "delayed"

  - `data.type` (string)
    Type of out payment.
    Enum: "normal", "instant"

  - `data.method` (string)
    Method used for the out payment.
    Enum: "transfer", "mb"

  - `data.customer` (object)
    Customer associated with the out payment.

  - `data.customer.id` (string)
    Unique identifier for the customer.

  - `data.account` (object)
    Easypay account from which the funds are transferred.

  - `data.account.id` (string)
    Unique identifier for the Easypay account.

  - `data.out_account` (object)
    Destination SEPA bank account for the out payment.

  - `data.out_account.id` (string)
    Unique identifier for the destination account.

  - `data.key` (string)
    Merchant reference key for the out payment.

  - `data.value` (number)
    Amount to be transferred.

  - `data.schedule_at` (string)
    Scheduled date and time for the out payment (YYYY-MM-DD HH:MM:SS).

  - `data.transactions` (object)
    Transaction related to the out payment.

  - `data.transactions.id` (string)
    A unique identifier for the entry, represented as a UUID. This ID is used to uniquely track and reference individual entries within the ledger system.
    Example: "4fb3ac57-c7fe-4157-aeb7-4362ae24deec"

  - `data.transactions.key` (string)
    A customizable text field for users to input their own identifier for the resource. This can be any string that helps the user uniquely identify or reference the resource in their own system.
    Example: "01J1PKR2RPHJNJQGFWGDYXY0KM"

  - `data.transactions.created_at` (string)
    The timestamp indicating when the resource was created. It is formatted as ISO 8601.
    Example: "2025-05-30T17:21:47Z"

  - `data.transactions.date` (string)
    The timestamp indicating when the resource was updated. It is formatted as ISO 8601.
    Example: "2025-05-30T17:21:46Z"

  - `data.transactions.values` (object)

  - `data.transactions.values.requested` (number)
    The amount requested, rounded by two decimapl plates.
    Example: 12.55

  - `data.transactions.values.paid` (number)
    The amount paid, rounded by two decimal plates.
    Example: 12.55

  - `data.transactions.values.fixed_fee` (number)
    The fixed fee amount applied to this transaction.
    Example: 0.07

  - `data.transactions.values.variable_fee` (number)
    The variable fee amount applied to this transaction.
    Example: 0.09

  - `data.transactions.values.tax` (number)
    The vat amount applied to this transaction.
    Example: 0.04

  - `data.transactions.values.transfer` (number)
    The net value to be transferred.
    Example: 12.35

  - `data.transactions.transfer_date` (string)
    The estimation when the funds will be transfered. It is formatted as ISO 8601.
    Example: "2025-06-02T00:00:00Z"

  - `data.transactions.transfer_batch` (string)
    A unique identifier for the transfer batch, typically represented as a string. This value is used to track and reference a specific batch of transfers within the system.
    Example: "584"

  - `data.transactions.method` (string)
    Method used for the transaction.
    Example: "transfer"

  - `data.transactions.document_number` (string)
    Unique document number used for Easypay Invoice.
    Example: "MARCEL0208220628294020250530172147"

  - `data.transactions.descriptive` (string)
    This is used to provide additional context or notes that describe the nature of the transaction in plain language.
    Example: "blue t-shirts"

  - `data.created_at` (string)
    Date and time when the out payment was created.
    Example: "2022-09-15 20:28:58"

  - `data.timestamp` (string)
    Timestamp of the last update or event for this out payment.
    Example: "1749054192"

## Response 403 fields (application/json):

  - `status` (string, required)

  - `message` (array, required)
    An array of human-readable messages included in the response. These messages provide detailed information about the success of the operation or explain the reasons for any failure. This field is always present in the response to ensure clarity and transparency regarding the outcome of the API request.

## Response 429 fields (application/json):

  - `status` (string, required)

  - `message` (array, required)
    An array of human-readable messages included in the response. These messages provide detailed information about the success of the operation or explain the reasons for any failure. This field is always present in the response to ensure clarity and transparency regarding the outcome of the API request.

## Response 500 fields (application/json):

  - `status` (string, required)

  - `message` (array, required)
    An array of human-readable messages included in the response. These messages provide detailed information about the success of the operation or explain the reasons for any failure. This field is always present in the response to ensure clarity and transparency regarding the outcome of the API request.