conomy_hq
  1. Payments
conomy_hq
  • Quickstart
    • Introduction
    • Obtain an Access Token
    • Create an Organization
    • Create users
    • Create accounts
    • Create your first top-up
    • Create your first withdrawal
    • Create your first purchase
    • Create your first p2p payment
    • Create your first collect payment
    • Supported Identity Document Types
  • Payments
    • Transaction types
    • Transaction status
    • Origins and Destinations
    • Creating a payment
    • Add & remove Fees
  • API reference
    • Auth
      • Auth
    • Identities
      • Create Identity
      • Get Identity
      • Update Identity
      • Delete Identity
      • Get Identities List
      • Add Child to Identity Children
      • Remove Child from Children
      • Add Rule to Identity
      • Remove Rule to Identity
    • Accounts
      • Create Account
      • Get Account
      • Update Account
      • Delete Account
      • Get multiple accounts
    • Payment-methods
      • Get payment-origins
      • Get payment-destinations
    • Payment-attempts
      • Create Attempt
      • Get payment-attempts list
      • Get payment-attempt
    • Payments
      • Create Payment
        POST
      • Authorize Payment
        POST
      • Capture Payment
        POST
      • Get Payment List
        GET
      • Get Payment List paginated
        GET
      • Get Payment
        GET
      • Receive Payment Provider Notification
        POST
      • Client Transaction's Notification Webhook
        POST
  1. Payments

Get Payment List paginated

GET
payments
Paginated endpoint
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'payments?identityId=1234a&type=PURCHASE&accountNumber=1234&status=CREATED&startDate=01/04/2025&endDate=08/04/2025&sort=createdAt:desc&limit=50&offset=0' \
--header 'conomyhq-api-version: 24-04-2025'
Response Response Example
{
  "pagination": {
    "count": 0,
    "next": 0,
    "previous": 0,
    "total": 0
  },
  "results": [
    {
      "externalId": "string",
      "name": "string",
      "type": "string",
      "amount": "string",
      "currency": "string",
      "settlement": "string",
      "fee": {
        "name": "string",
        "type": "string",
        "value": "string",
        "currency": "string"
      },
      "identity": {
        "name": "string",
        "documentNumber": "string",
        "externalId": "string",
        "lastname": "string"
      },
      "bank": {
        "accountNumber": "string",
        "bank": "string",
        "currency": "string",
        "typeAccount": "string",
        "accountHolder": "string",
        "accountHolderDni": "string",
        "country": "string"
      },
      "account": {
        "id": "string",
        "identityId": "string",
        "externalId": "string",
        "type": "string",
        "currency": "string",
        "accountNumber": "string",
        "accountHolder": "string",
        "custodyBankAccount": {
          "accountNumber": "string",
          "bank": "string",
          "currency": "string",
          "typeAccount": "string",
          "country": "string"
        }
      },
      "paymentInitiation": {
        "type": "string",
        "origin": "string",
        "referenceId": "string",
        "description": {
          "title": "string",
          "icon": "string",
          "color": "string"
        },
        "url": "string",
        "token": "string",
        "minimumAmount": "string",
        "maximumAmount": "string"
      },
      "card": {
        "type": "string",
        "origin": "string",
        "referenceId": "string",
        "description": {
          "title": "string",
          "icon": "string",
          "color": "string"
        },
        "url": "string",
        "token": "string",
        "minimumAmount": "string",
        "maximumAmount": "string"
      },
      "metadata": {
        "image": "string",
        "description": "string",
        "category": "string"
      },
      "paymentLink": {
        "expiredAt": "string",
        "name": "string",
        "metadata": {
          "description": "string"
        },
        "paymentMethods": [
          "string"
        ],
        "payer": {
          "name": "string",
          "email": "string"
        },
        "provider": "string"
      }
    }
  ]
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params
identityId
string 
optional
Identity Id
Example:
1234a
type
string 
optional
Payment type (PURCHASE | WITHDRAWAL_ACCOUNT | COLLECT | P2P | TOPUP_ACCOUNT)
Example:
PURCHASE
accountNumber
string 
optional
Account Number
Example:
1234
status
string 
optional
Payment status
Example:
CREATED
startDate
string 
optional
(dd/mm/yyyy) Start date filters created Date min
Example:
01/04/2025
endDate
string 
optional
(dd/mm/yyyy) End date filters created Date max
Example:
08/04/2025
sort
string 
optional
Sorts the results by param:asc | param:desc
Example:
createdAt:desc
limit
string 
optional
Specifies the maximum number of items to return in a single request.
Example:
50
offset
string 
optional
Skips the input value from the current view
Example:
0
Header Params
conomyhq-api-version
string 
optional
v1: empty ; v2: 24-04-2025
Default:
none, is the first API version
Example:
24-04-2025

Responses

🟢200Success
application/json
Body
pagination
object (Pagination cursor) 
required
Pagination cursor object
count
integer  | null 
required
count of items shown up to the moment
next
integer  | null 
required
next cursor to be used in offset to display the next page
previous
integer  | null 
required
previous cursor to be used in offset to display the previous page
total
integer  | null 
required
total count of items to be shown
results
array[object (Payment) {14}] 
required
Items from the current page
externalId
string 
optional
External reference identifier for integrations.
name
string 
optional
The name of the source or destination of the transaction.
type
string 
optional
The type of source or destination BANK_ACCOUNT, CRYPTO, CARD, PAYMENT_INITIATION, ACCOUNT
amount
string 
optional
The amount involved in the transaction.
currency
string 
optional
The currency of the transaction (e.g., USD, EUR).
settlement
string 
optional
Indicates the settlement period.
fee
object 
optional
Details about any fees applied to the transaction.
identity
object 
optional
The entity associated with the source or destination.
bank
object 
optional
Details of the bank involved in the transaction.
account
object 
optional
The account associated with the source or destination.
paymentInitiation
object (paymentsMethods) 
optional
Details of a payment initiation, if applicable.
card
object (paymentsMethods) 
optional
Details of a card transaction, if applicable.
metadata
object 
optional
Additional metadata related to the transaction source or destination.
paymentLink
object (paymentLink) 
required
Modified at 2025-04-24 18:31:50
Previous
Get Payment List
Next
Get Payment
Built with