Skip to content
/
Lists out payments

Lists out payments

Request

Full report with all the out payments from your Account Id

Required scope: out_payment:read

Security
accountId and apiKey
Query
pageinteger

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).

Default:1
Example:page=1
records_per_pageinteger

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).

Default:20
Example:records_per_page=20
methodstring

Filter by method used in the transaction.

Enum:"transfer""mb"
typestring

Filter by type of out payment.

Enum:"normal""instant"
idstring, (uuid)

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

Example:id=bb3e7e60-20f3-4208-9b21-64c635a51f42
keystring

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:key=01J32EESEC1Z543P7J3PKSF1Q9
valuenumber, (double)

Filter records by the exact transaction amount.

Example:value=10.32
created_atstring

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:created_at=interval(2006-01-02 15:04,2006-01-02 15:04)
curl -i -X GET \
  'https://api.test.easypay.pt/2.0/out_payment?page=1&records_per_page=20&method=transfer&type=normal&id=bb3e7e60-20f3-4208-9b21-64c635a51f42&key=01J32EESEC1Z543P7J3PKSF1Q9&value=10.32&created_at=interval(2006-01-02%2015%3A04%2C2006-01-02%2015%3A04)' \
  -H 'AccountId: 2b0f63e2-9fb5-4e52-aca0-b4bf0339bbe6' \
  -H 'ApiKey: eae4aa59-8e5b-4ec2-887d-b02768481a92'

Responses

OK

Bodyapplication/json
metaobject(metadata-page)

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.

dataArray of objects(out-payment-response)
Response
{
  "meta": {
    "page": { … },
    "records": { … },
    "links": { … }
  },
  "data": [
    { … },
    { … }
  ]
}