Get Payments List

The API retrieves payment details and summarizes and fetches comprehensive information about all payments associated with the organization account with optional filters. Results are paginated, with a default list limit of 50 results.

GET /payments/payments

Body Parameters - Request

Name	Location	Type	Format / Values	Description	Example
id	Url parameter	array	string	Payment request id's
description	Url parameter	string		Description substring
request_until	Url parameter	string	date-time	Request End Date
request_from	Url parameter	string	date-time	Request Start Date
funding_until	Url parameter	string	date-time	Funding End Date
funding_from	Url parameter	string	date-time	Funding Start Date
execution_until	Url parameter	string	date-time	Execution End Date
execution_from	Url parameter	string	date-time	Execution Start Date
amount_type	Url parameter	AmountTypeEnum	SEND, LAND	Amount type LAND/SEND
approved	Url parameter	boolean		return only payment requests that are approved (true) or not approved (false), don't send to return both
final	Url parameter	boolean		return only payment requests that are final (true) or not final (false), don't send to return both
has_issues	Url parameter	boolean		return only payment requests that have issues (true) or have no issues (false), don't send to return both
purpose	Url parameter	array	string:/^[A-Z]{4}$/	the purpose of the payment as a 4 letter iso-20022 code. see: <External code sets | ISO20022
source	Url parameter	string		Return payment requests only from specific group
filters.status	Url parameter	array	string	Return only payment requests with specific status's
tag	Url parameter	array	tag:name={value}	A list of tags and their values to filter by	?tag:department=sales&tag:department=marketing
target	Url parameter	string		target method
skip	Url parameter	integer
take	Url parameter	integer

Body Parameters - Response

Name	Type	Format / Values	Description
items	array	object
items[]	object
items[].type	string	payment	entity type (payment)
items[].id	string		The unique id of the payment
items[].description	string		The remittence info to send as part of the payment
items[].amount	object		Specifies the amount of the payment
items[].amount.type	string	LAND, SEND	Does the amount refer to the amount credited (LAND), or the amount debited (SEND)
items[].amount.amount	number		The amount (up to 3 decimal points)
items[].amount.currency	string	/^[A-Z]{3}$/	If the amount currency is different than the sender (for SEND) or target (for LAND), specify the 3 letter ISO currency code of the payment
items[].approved	boolean		Has this payment been approved and ready for execution
items[].execution	object		specifies info for the executing date
items[].execution.type	string	SEND, LAND	Does the date refer to the date the funds should arrive (LAND) or the date the funds should be sent (SEND), defaults to amount.type (future support)
items[].execution.date	string	date-time	The date this payment should be sent on (for SEND payments) or the date this payment should arrive by (for LAND payments)
items[].execution.margin	integer		number of hours before execution date, this payment may be sent if funds exist
items[].final	object		Properties describing the finalization of this payment details
items[].final.is_final	boolean		is the amount final
items[].final.expected	string	date-time	If the amount is not final yet, when is the final amount expected
items[].purpose	string	/^[A-Z]{4}$/	the purpose of the payment as a 4 letter iso-20022 code. see: <External code sets | ISO20022
items[].source	PaymentRequestMethodEntity		source method
items[].source.type	string		the type of the entity
items[].source.id	string		the id of the entity
items[].target	object
target.type	string		the type of the entity
items[].target.id	string
items[].attachments	array	object	List of files to attach to the payment
items[].attachments[]	object
items[].attachments[].id	string		a unique id to give the attachment
items[].attachments[].title	string		A title to give the attachment
items[].attachments[].url	string		a url link to the attachment
items[].user_tags	object		A set of key/value pairs to tag the payment with
items[].info	object		Extra info on the payment and its execution
items[].info.status	PaymentRequestStatusEnum	PENDING, COMPLETED, FAILED, PROCESSING, PARTIAL, CANCELLED, PROCESSED	The current payment status
items[].info.credit	object		If the payment has been processed, holds the amount credited
items[].info.credit.currency	string	/^[A-Z]{3}$/	the 3 letter ISO currency code this payment will be credited in
items[].info.credit.amount	number		The amount credited
items[].info.funding	object		If the payment has not been processed yet, holds information about the funding requirments
items[].info.funding.currency	string	/^[A-Z]{3}$/	the 3 letter ISO currency code this amount is to be funded in
items[].info.funding.amount	number		The amount required to fund
items[].info.funding.date	string	date-time	The date the funding amount must arrive in the wallet by for this payment to execute on time
items[].info.debit	object		The amount to be debited to wallet
items[].info.debit.currency	string	/^[A-Z]{3}$/	the 3 letter ISO currency code this payment will be debited in
items[].info.debit.amount	number		The amount debited
items[].info.rate	number		FX rate applied to this payment (when cross currency)
items[].info.fees	number		Total amount (in debiting currency) of the debited amount collected as a transactional fee
paging	Paging
paging.skip	integer
paging.take	integer

Request Example

GET /payments/payments?take=3

Response Examples

200 - OK

{
   "items": [
      {
         "id": "0Il4BnTWQbyDVCBLxYuw5A",
         "purpose": "SALA",
         "source": {
            "id": "4990e5e9-347a-48ed-b4c6-b0ef19d39a24",
            "type": "group"
         },
         "target": {
            "type": "contact",
            "id": "16"
         },
         "info": {
            "funding": {
               "date": "2024-02-28T09:09:51Z",
               "currency": "GBP",
               "amount": 4504.01292
            },
            "status": "PENDING",
            "credit": {
               "currency": "EUR",
               "amount": 5000
            },
            "rate": 1.11012115,
            "fees": 0
         },
         "amount": {
            "type": "LAND",
            "amount": 5000
         },
         "execution": {
            "date": "2024-03-02T09:09:51Z"
         },
         "final": {
            "is_final": true,
            "expected": "2024-02-28T09:09:51Z"
         },
         "attachemnts": [],
         "approved": true,
         "user_tags": {}
      },
      {
         "id": "1ayA-gyQSSySsCpX-03Q3Q",
         "purpose": "SALA",
         "source": {
            "id": "4990e5e9-347a-48ed-b4c6-b0ef19d39a24",
            "type": "group"
         },
         "target": {
            "type": "contact",
            "id": "5"
         },
         "info": {
            "funding": {
               "date": "2024-02-28T05:00:00Z",
               "currency": "GBP",
               "amount": 4163.26254
            },
            "status": "PENDING",
            "credit": {
               "currency": "USD",
               "amount": 5000
            },
            "rate": 1.20477008,
            "fees": 13.09306
         },
         "amount": {
            "type": "LAND",
            "amount": 5000
         },
         "execution": {
            "date": "2024-03-02T09:09:51Z"
         },
         "final": {
            "is_final": true,
            "expected": "2024-02-28T05:00:00Z"
         },
         "attachemnts": [],
         "approved": true,
         "user_tags": {}
      },
      {
         "id": "25dnoBmXRPyqkjV5WX4nsA",
         "purpose": "SALA",
         "source": {
            "id": "4990e5e9-347a-48ed-b4c6-b0ef19d39a24",
            "type": "group"
         },
         "target": {
            "type": "contact",
            "id": "3"
         },
         "info": {
            "funding": {
               "date": "2024-02-28T05:00:00Z",
               "currency": "GBP",
               "amount": 8313.43201
            },
            "status": "PENDING",
            "credit": {
               "currency": "USD",
               "amount": 10000
            },
            "rate": 1.20477008,
            "fees": 13.09306
         },
         "amount": {
            "type": "LAND",
            "amount": 10000
         },
         "execution": {
            "date": "2024-03-02T09:09:51Z"
         },
         "final": {
            "is_final": true,
            "expected": "2024-02-28T05:00:00Z"
         },
         "attachemnts": [],
         "approved": true,
         "user_tags": {}
      }
   ],
   "paging": {
      "take": 3,
      "skip": 0
   }
}

400 - Bad Request

{
  "error": "bad_request",
  "description": "Validation errors: {\"type\":\"INDIVIDUAL\",\"id\":\"5SYjAkHqXHW0Z2cqBRW4JAAA\",\"cou... at root failed with \"Missing property org_id\"",
  "error_code": 400
}