wallets
The Get Wallet Details API designed to provide comprehensive details about a specific wallet associated with an organization’s account. By using this API, developers can retrieve essential information such as wallet IDs, balances, currencies, owner details, and funding information. This API is crucial for managing and monitoring wallet resources, ensuring that organizations have a clear view of their financial assets.
the wallet id to fetch
Successful response
the type of entity (wallet)
the id of the wallet
The available amount in the wallet
^[-]?\d+(\.\d+)?$Account funding details
Legal entity id owning this wallet
current state of wallet
Optional user-defined tags associated with the wallet (e.g., department).
GET /payments/wallets/{id} HTTP/1.1
Host: api.cust1.papaya-sandbox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Successful response
{
"type": "text",
"id": "text",
"balance": 1,
"funding": {},
"owner": "text",
"state": "DISABLED",
"user_tags": {}
}The Get Wallets List API designed to provide comprehensive details about all wallets associated with an organization’s account. By using this API, developers can retrieve essential information such as wallet IDs, balances, currencies, owner details, and funding information. This API is crucial for managing and monitoring wallet resources, ensuring that organizations have a clear view of their financial assets.
Used to filter the list of wallets based on their unique identifiers.
Used to filter the wallets returned in the response based on their active status.If set to true, only active wallets will be returned. If false, all existing wallets will be returned.
list of currency codes to filter by
^[A-Z]{3,3}$Used to control pagination by specifying the number of items (wallets) to skip before starting to return results. For example, if you have already viewed the first 10 wallets and want to view the next set, you would set skip=10 to skip the first 10 and start the next retrieval from the 11th wallet onward.
Used to control pagination by specifying the number of items (wallets) to return in the response. This is useful for limiting the size of the result set, especially when dealing with large numbers of wallets. For example,If you want to retrieve 10 wallets in the response, you would set take=10.
50Successful response
GET /payments/wallets HTTP/1.1
Host: api.cust1.papaya-sandbox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Successful response
{
"items": [
{
"name": "text",
"type": "text",
"id": "text",
"currency": "text",
"owner": "text",
"funding": {
"name": "text",
"country": "text",
"account_number": "text",
"currency": "text",
"bic": "text",
"iban": "text"
},
"balance": 1,
"user_tags": {},
"state": "text"
}
],
"paging": {
"take": 1,
"skip": 1
}
}The Get Wallet Statements API designed to provide transaction statements for a specific wallet. By using this API, developers can retrieve transaction statements for a specific wallet by providing the wallet’s unique ID and a date range. The response includes detailed transaction records, such as credits, debits, and fees, along with pagination options.
Used to specify the unique identifier of the wallet for which the transaction statements are being retrieved.
Used to specify the start date and time for the period over which you want to retrieve wallet transaction statements. It marks the earliest point in time from which transactions will be included in the response. This parameter is typically used in conjunction with the end parameter to define a specific period for the statement retrieval.The start parameter should be provided in a standard date-time format, typically ISO 8601 (e.g., 2023-02-28T00:00:00.000Z).
Used to specify the end date and time for the period over which you want to retrieve wallet transaction statements. It is used in conjunction with the start parameter to specify the full time period of interest. If not provided, the API might return statements up to the current date and time or another default endpoint set by the API. The end parameter should be provided in a standard date-time format, typically ISO 8601 (e.g., 2024-02-29T09:33:21.689Z).
Used to control pagination by specifying the number of items (statements) to skip before starting to return results. For example, if you have already viewed the first 10 wallets and want to view the next set, you would set skip=10 to skip the first 10 and start the next retrieval from the 11th wallet onward.
Used to control pagination by specifying the number of items (statements) to return in the response. This is useful for limiting the size of the result set, especially when dealing with large numbers of wallets. For example,If you want to retrieve 10 wallets in the response, you would set take=10.
50Successful response
The unique identifier of the wallet.
The start date and time of the statement period.
The end date and time of the statement period.
GET /payments/wallets/{id}/statement HTTP/1.1
Host: api.cust1.papaya-sandbox.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Successful response
{
"type": null,
"id": "text",
"start_date": "2026-01-01T00:00:00.000Z",
"end_date": "2026-01-01T00:00:00.000Z",
"items": [
{
"type": "payment",
"description": "text",
"id": "text",
"execution_id": "text",
"date": "2026-01-01T00:00:00.000Z",
"action": "CREDIT",
"debit": {
"amount": 1,
"currency": "text"
},
"credit": {
"amount": 1,
"currency": "text"
},
"fees": 1,
"rate": 1,
"balance": 1,
"counterpart": {
"name": "text",
"id": "text",
"currency": "text",
"bank_details": {
"account_country": "text",
"account_name": "text"
},
"entity": {},
"active": true,
"user_tags": {}
},
"user_tags": {},
"tags": {}
}
],
"paging": {
"skip": 1,
"take": 50
}
}Last updated