Get Payment Groups List

The API is utilized to retrieve Payment Groups' details and fetch comprehensive information about all the groups associated with the organization account, with optional filters. Results are paginated, with a default list limit of 50 results.

GET /payments/groups

Body Parameters Request

Name	Location	Type	Description	Example
id	Url parameters	array	a list of group id's to filter by	?id=aaa&id=bbb
description	Url parameters	string	description of group to filter by (description)	?description=Cycle
name	Url parameters	string	name of group to filter by (name)	?name=test
locked	Url parameters	array		?locked=true&locked=false
wallet	Url parameters	array	a list of wallet id's to filter by	?wallet=wallet_1&wallet=wallet_2
tag	Url parameters	array	a key/values[] dictionary to filter results based on their tags	?tag:department=sales&tag:department=operations
skip	Url parameters	integer	the number of items to skip in the result set
take	Url parameters	integer	the maximum number of items to return in the result set

Body parameters Response

Name	Type	Format / Values	Description
items	array	object
items[]	object
items[].type	string		the entity type (group)
items[].id	string		Unique id of group
items[].description	string		Extended description of group
items[].name	string		Visual name of group
items[].locked	boolean		When locked, no new payments can be added
items[].user_tags	object		A set of k/v pairs of user tags assigned to this group
items[].wallet	object		Holds info on the wallet this group is associated with
items[].wallet.type	string		Entity type (wallet)
items[].wallet.id	string		The unique id of this wallet
items[].wallet.currency	string		The 3 letter ISO code of the currency this wallet holds
items[].wallet.name	string		Visual name of this wallet
items[].wallet.balance	integer		When the wallet is active, returns the available balance
items[].wallet.owner	string		The legal entity id owning this wallet
items[].info	object		Extended information amount payment in this group
items[].info.funding	object		Info on the next funding
items[].info.funding.next	string	date	The next funding date
items[].info.funding.missing_funds	number		The amount of funds missing for the next payout date
items[].info.payments	object		Extended information regarding payments in the group
items[].info.payments.total	integer		Total number of payments in this group
items[].info.payments.pending	integer		Number of payments pending to be executed
items[].info.payments.pending_approval	integer		Number of payments that have not been approved yet
items[].info.payments.issues	integer		Number of payments with issues that require user attention
items[].info.payments.completed	integer		Number of payments that have been completed
items[].info.payments.failed	integer		Number of payments that have failed
items[].info.payments.routing	integer		Number of payments that have started their execution and are in the bank routing stage
items[].info.payments.next	string	date	The next expected payout date
items[].info.payments.amount	object		Information about the total amount to be sent from this group
items[].info.payments.amount.amount	number		The total amount of charges this group holds
items[].info.payments.amount.currency	string		The currency these payments are charged in
paging	object
paging.skip	integer		Number of items to skip in the result set
paging.take	integer		Number of items to return from the result set

Request Example

GET /payments/groups?take=2

Response Examples

200 - OK

{
   "items": [
      {
         "type": "group",
         "id": "b9eabf6f-2292-4f84-ba65-eb4507cf18db",
         "description": "Demo Group",
         "name": "March EUR cycle",
         "locked": false,
         "user_tags": {},
         "wallet": {
            "type": "wallet",
            "id": "f5a6c2d7-8c59-415e-8684-3c4a27b42cba",
            "currency": "EUR",
            "name": "Demo EUR Wallet",
            "balance": 120000,
            "owner": "entity://business/customer/demo:standalone:1709465100/legal/a01b75a8-8069-4691-a299-11a9477f8899"
         },
         "info": {
            "funding": {
               "next": "2024-03-02",
               "missing_funds": 110786.74181
            },
            "payments": {
               "total": 20,
               "pending": 20,
               "pending_approval": 0,
               "issues": 20,
               "completed": 0,
               "failed": 0,
               "routing": 0,
               "next": "2024-03-02",
               "amount": {
                  "amount": 110786.74181,
                  "currency": "EUR"
               }
            }
         }
      },
      {
         "type": "group",
         "id": "9ae49428-89c7-4893-9d41-4ccdd9b9b229",
         "description": "Demo Group",
         "name": "March GBP cycle",
         "locked": false,
         "user_tags": {},
         "wallet": {
            "type": "wallet",
            "id": "a8aa4b6a-fc6c-4de5-b99e-ae155d9a154c",
            "currency": "GBP",
            "name": "Demo GBP Wallet",
            "balance": 120000,
            "owner": "entity://business/customer/demo:standalone:1709465100/legal/a01b75a8-8069-4691-a299-11a9477f8899"
         },
         "info": {
            "funding": {
               "next": "2024-03-02",
               "missing_funds": 93529.20039
            },
            "payments": {
               "total": 20,
               "pending": 20,
               "pending_approval": 0,
               "issues": 20,
               "completed": 0,
               "failed": 0,
               "routing": 0,
               "next": "2024-03-02",
               "amount": {
                  "amount": 93529.20039,
                  "currency": "GBP"
               }
            }
         }
      }
   ],
   "paging": {
      "skip": 0,
      "take": 2
   }
}

400 - Bad Request

{
  "error": "bad_request",
  "description": "Validation errors: {\"filters\":{\"id\":[\"cf54388a-bf7b-4d0b-aa1b-7a33dfbc26df\"]... at root failed with \"Missing property org_id\"",
  "error_code": 400
}