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

GET
payments
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'payments?type&identityId&accountNumber&startDate&endDate&limit&n&status'
Response Response Example
[
  {
    "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
type
string 
optional
payment type
identityId
string 
optional
identity Id
accountNumber
string 
optional
account Number
startDate
string 
optional
Start date filter
endDate
string 
optional
End date filter
limit
string 
optional
Specifies the maximum number of items to return in a single request.
n
string 
optional
A cursor indicating the position of the last retrieved item.
status
string 
optional
payment status

Responses

🟢200Success
application/json
Body
array of:
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.
name
string 
required
The name of the fee.
type
string 
required
The type of fee applied (e.g., FIXED, PERCENTAGE).
value
string 
required
The value of the fee.
currency
string 
required
The currency in which the fee is charged. USD, EUR, CLP, ARS, COP, PER, SOL_USDC
identity
object 
optional
The entity associated with the source or destination.
name
string 
optional
The name of the entity (for users) or the official name (for organizations).
documentNumber
string 
optional
The document number associated with the entity for identification purposes.
externalId
string 
optional
External reference ID (client purpose).
lastname
string 
optional
The last name of the user (if applicable).
bank
object 
optional
Details of the bank involved in the transaction.
accountNumber
string 
required
The bank account number.
bank
string 
required
The name of the bank where the account is held.
currency
string 
required
The currency in which the account operates. USD, EUR, CLP, ARS, COP, PER, SOL_USDC
typeAccount
string 
optional
The type of bank account. CHECKING_ACOUNT, SAVINGS, ASSET
accountHolder
string 
required
The full name of the account holder.
accountHolderDni
string 
required
The national identification number or tax ID of the account holder.
he country of operations of the entity
country
string 
optional
The country where the bank account is registered. CHL, PER, COL, ARG, MEX, USA, CAD
account
object 
optional
The account associated with the source or destination.
id
string 
required
Unique identifier for the internal account.
identityId
string 
required
Identifier linking the internal account to an organization or user.
externalId
string 
required
External reference identifier for integrations.
type
string 
required
The type of internal account (e.g., CHECKING, ASSET, SAVINGS).
currency
string 
required
The currency in which the internal account operates. USD, EUR, CLP, ARS, COP, PER, SOL_USDC
accountNumber
string 
required
Internal reference number for the account.
accountHolder
string 
required
Name of the entity or user owning the internal account.
custodyBankAccount
object 
optional
Details of the custody bank account linked to this internal account.
paymentInitiation
object (paymentsMethods) 
optional
Details of a payment initiation, if applicable.
type
string 
required
The payment method type. Possible values: ETPAY, FINTOC, TRANSBANK_WEBPAY, TRANSBANK_ONECLICK, KHIPU.
origin
string 
optional
The origin of the payment request.
referenceId
string 
optional
A unique identifier for the payment reference.
description
object 
required
Descriptive details for the payment method.
url
string 
required
The URL to redirect the user to complete the payment, if applicable.
token
string 
required
The access token required for authentication.
minimumAmount
string 
required
The minimum allowed transaction amount.
Match pattern:
^\d+$
maximumAmount
string 
required
The maximum allowed transaction amount.
Match pattern:
^\d+$
card
object (paymentsMethods) 
optional
Details of a card transaction, if applicable.
metadata
object 
optional
Additional metadata related to the transaction source or destination.
image
string 
required
An image representing the source or destination.
description
string 
required
A brief description of the source or destination.
category
string 
required
The category or grouping of the source or destination.
paymentLink
object (paymentLink) 
required
expiredAt
string 
optional
When the link expires
name
string 
required
Name of the payment link
metadata
object 
required
paymentMethods
array[string]
optional
Allowed payment methods if applies.
payer
object 
required
Description about the payer
provider
string 
required
Payment Gateway Provider. for example: WOMPI
Modified at 2025-04-16 22:27:57
Previous
Capture Payment
Next
Get Payment List paginated
Built with