conomy_hq
  1. Payment-attempts
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
        POST
      • Get payment-attempts list
        GET
      • Get payment-attempt
        GET
    • Payments
      • Create Payment
      • Authorize Payment
      • Capture Payment
      • Get Payment List
      • Get Payment List paginated
      • Get Payment
      • Receive Payment Provider Notification
      • Client Transaction's Notification Webhook
  1. Payment-attempts

Get payment-attempts list

GET
payment-attempts
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'payment-attempts?identityId&accountNumber&type&startDate&endDate&limit&next'
Response Response Example
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "type": "string",
      "name": "string",
      "nickname": "string",
      "email": "user@example.com",
      "phone": "string",
      "documentNumber": "string",
      "documentType": "string",
      "idv": "string",
      "securityOptions": {
        "twoFactorAuth": true,
        "signTrx": true,
        "signAccountsOperations": true
      },
      "country": "string",
      "children": [
        {
          "id": "string",
          "name": "string",
          "email": "string"
        }
      ],
      "status": "string",
      "externalId": "string",
      "lastname": "string",
      "bankAccount": {
        "id": "string",
        "externalId": "string",
        "accountNumber": "string",
        "nickname": "string",
        "bank": "string",
        "currency": "string",
        "typeAccount": "string",
        "accountHolder": "string",
        "accountHolderDni": "string",
        "country": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
      },
      "rules": {},
      "gender": "string",
      "kyc": {},
      "watchList": {},
      "extendedData": [
        "string"
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "address": {
        "administrativeAreaLevel1": "string",
        "administrativeAreaLevel2": "string",
        "administrativeAreaLevel3": "string",
        "street": "string",
        "streetNumber": "string",
        "optionalAddress": "string",
        "country": "string"
      }
    }
  ],
  "pagination": {
    "pagination": {
      "count": 0,
      "next": 0,
      "previous": 0,
      "total": 0
    },
    "results": [
      {}
    ]
  }
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params
identityId
string 
optional
identityId
accountNumber
string 
optional
account number
type
string 
optional
Type of payment-attempt
startDate
string 
optional
start date filter
endDate
string 
optional
start date filter
limit
string 
optional
Specifies the maximum number of items to return in a single request.
next
string 
optional
A cursor indicating the position of the last retrieved item.

Responses

🟢200Success
application/json
Body
data
array[object (identity) {24}] 
required
An array containing the list of retrieved payment-attemps based on the provided pagination parameters.
id
string <uuid>
optional
Unique identifier for the entity.
type
string 
optional
Specifies whether the entity is an ORGANIZATION or an individual USER.
name
string 
optional
The name of the entity (for users) or the official name (for organizations).
nickname
string 
optional
An alternative or preferred name for the entity.
email
string <email>
optional
The email address associated with the entity.
phone
string 
optional
he phone number linked to the entity. Include +(phone country code)
documentNumber
string 
optional
The document number associated with the entity for identification purposes.
documentType
string 
optional
The type of document PASSPORT, RFC, RUT, CED_CIU, CED_EXT, NIT, DNI, CE, RUC, DNI, CUIT
idv
string 
optional
Identity verification reference
securityOptions
object 
optional
country
string 
optional
he country of operations of the entity CHL, PER, COL, ARG, MEX, USA, CAD
children
array [object {3}] 
optional
A list of related entities (e.g., subsidiaries for organizations or dependent users
status
string 
optional
The current status of the entity. PENDING, PENDING_EMAIL_VALIDATION, PENDING_PHONE_VALIDATION, SCREENING, ACTIVE
externalId
string 
optional
External reference ID (client purpose).
lastname
string 
optional
The last name of the user (if applicable).
bankAccount
object (bankAccount) 
optional
A reference to the associated bank account
rules
object 
optional
Custom rules or policies applicable to the entity.
gender
string 
optional
Gender information (if applicable
kyc
object 
optional
Information related to Know Your Customer (KYC) compliance
watchList
object 
optional
Watchlist information for compliance or fraud detection.
extendedData
array[string]
optional
Additional data.
createdAt
string <date-time>
optional
Creation date UTC format.
updatedAt
string <date-time>
optional
Time of last update made to the entity, UTC format.
address
object 
optional
The entity’s address information.
pagination
object (Pagination) 
required
An object containing pagination metadata that helps navigate through the dataset.
pagination
object (Pagination cursor) 
required
Pagination cursor object
results
array [object] 
required
Items from the current page
Modified at 2025-02-01 19:48:11
Previous
Create Attempt
Next
Get payment-attempt
Built with