Payments
Paginated endpoint
Authorizations
Query parameters
identityIdstringOptionalExample:
Identity Id
1234atypestringOptionalExample:
Payment type (PURCHASE | WITHDRAWAL_ACCOUNT | COLLECT | P2P | TOPUP_ACCOUNT)
PURCHASEaccountNumberstringOptionalExample:
Account Number
1234statusstringOptionalExample:
Payment status
CREATEDstartDatestringOptionalExample:
(dd/mm/yyyy) Start date filters created Date min
01/04/2025endDatestringOptionalExample:
(dd/mm/yyyy) End date filters created Date max
08/04/2025sortstringOptionalExample:
Sorts the results by param:asc | param:desc
createdAt:desclimitstringOptionalExample:
Specifies the maximum number of items to return in a single request.
50offsetstringOptionalExample:
Skips the input value from the current view
0Header parameters
conomyhq-api-versionstringOptionalDefault:
v1: empty ; v2: 24-04-2025
none, is the first API versionExample: 24-04-2025Responses
200Success
application/json
get
GET /payments HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
"pagination": {
"count": null,
"next": null,
"previous": null,
"total": null
},
"results": [
{
"name": "text",
"type": "text",
"externalId": "text",
"amount": "text",
"amountOut": "text",
"currency": "text",
"settlement": "text",
"fee": {
"name": "text",
"type": "text",
"value": "text",
"amount": "text",
"currency": "text"
},
"identity": {
"name": "text",
"documentNumber": "text",
"externalId": "text",
"lastname": "text"
},
"bank": {
"accountNumber": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text"
},
"account": {
"id": "text",
"identityId": "text",
"externalId": "text",
"type": "text",
"currency": "text",
"accountNumber": "text",
"accountHolder": "text",
"custodyBankAccount": {
"accountNumber": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"country": "text"
}
},
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"paymentInitiation": {
"type": "text",
"origin": "text",
"referenceId": "text",
"description": {
"title": "text",
"icon": "text",
"color": "text"
},
"url": "text",
"token": "text",
"minimumAmount": "text",
"maximumAmount": "text"
},
"paymentLink": {
"provider": "text",
"name": "text",
"payer": {
"name": "text",
"email": "text"
},
"paymentMethods": [
"text"
],
"paymentMethod": {
"type": "text",
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"bank": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-06-23T03:34:58.351Z",
"updatedAt": "2025-06-23T03:34:58.351Z"
},
"wallet": {
"accountId": "text",
"provider": "text",
"referenceId": "text",
"address": "text"
}
},
"expiredAt": "text",
"metadata": {
"description": "text"
}
},
"externalCheckout": {
"provider": "text",
"configuration": {
"currency": "text",
"amount": "text",
"reference": "text",
"redirectURL": "text",
"expirationTime": "text",
"description": "text"
},
"customer": {
"email": "text",
"fullName": "text",
"firstName": "text",
"lastName": "text",
"phoneNumber": "text",
"legalId": "text",
"legalIdType": "text"
},
"authentication": {
"publicKey": "text",
"token": "text"
},
"providerResponse": {
"providerCheckoutId": "text",
"checkoutURL": "text",
"sessionCode": "text",
"status": "text",
"additionalData": {}
},
"paymentMethod": {
"type": "text",
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"bank": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-06-23T03:34:58.351Z",
"updatedAt": "2025-06-23T03:34:58.351Z"
},
"wallet": {
"accountId": "text",
"provider": "text",
"referenceId": "text",
"address": "text"
}
}
},
"metadata": {
"image": "text",
"description": "text",
"category": "text"
}
}
]
}When creating a transaction, this endpoint provides a payment method and a provider system to process the payment.
Authorizations
Header parameters
x-api-keystringOptional
User-AgentstringOptional
Body
objectOptional
Responses
200Success
application/json
400Error
application/json
500Error
application/json
post
POST /payments HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 567
{
"identityId": "679c482ee4420cb5b0966c9a",
"accountNumber": "123456",
"product": "ARS:ARS",
"type": "PAYMENT",
"purchaseAmount": "100",
"purchaseCurrency": "ARS",
"currency": "ARS",
"origins": [
{
"name": "ETPAY",
"type": "PAYMENT_INITATION",
"amount": "100",
"currency": "ARS",
"paymentInitiation": {
"origin": "ETPAY",
"referenceId": "external_payment_id_1"
}
}
],
"destinations": [
{
"type": "ACCOUNT",
"amount": "100",
"currency": "ARS",
"identity": {
"userId": "679c482ee4420cb5b0966c9a",
"name": "Juan Pérez",
"lastname": "Zúñiga",
"nickname": "Juanpe",
"dni": "12312252"
},
"account": {
"accountNumber": "123456"
}
}
]
}{
"id": "text",
"externalId": "text",
"identityId": "text",
"identityExternalId": "text",
"accountNumber": "text",
"totalAmount": "text",
"currency": "text",
"description": "text",
"product": "text",
"status": "text",
"type": "P2P",
"purchaseAmount": "text",
"purchaseCurrency": "text",
"fees": [
{
"name": "text",
"type": "text",
"value": "text",
"amount": "text",
"currency": "text"
}
],
"createdAt": "text",
"updatedAt": "text",
"expiresAt": "text",
"capturedAt": "text",
"authorizedAt": "text",
"refundedAt": "text",
"origins": [
{
"name": "text",
"type": "text",
"externalId": "text",
"amount": "text",
"amountOut": "text",
"currency": "text",
"settlement": "text",
"fee": {
"name": "text",
"type": "text",
"value": "text",
"amount": "text",
"currency": "text"
},
"identity": {
"name": "text",
"documentNumber": "text",
"externalId": "text",
"lastname": "text"
},
"bank": {
"accountNumber": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text"
},
"account": {
"id": "text",
"identityId": "text",
"externalId": "text",
"type": "text",
"currency": "text",
"accountNumber": "text",
"accountHolder": "text",
"custodyBankAccount": {
"accountNumber": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"country": "text"
}
},
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"paymentInitiation": {
"type": "text",
"origin": "text",
"referenceId": "text",
"description": {
"title": "text",
"icon": "text",
"color": "text"
},
"url": "text",
"token": "text",
"minimumAmount": "text",
"maximumAmount": "text"
},
"paymentLink": {
"provider": "text",
"name": "text",
"payer": {
"name": "text",
"email": "text"
},
"paymentMethods": [
"text"
],
"paymentMethod": {
"type": "text",
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"bank": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-06-23T03:34:58.351Z",
"updatedAt": "2025-06-23T03:34:58.351Z"
},
"wallet": {
"accountId": "text",
"provider": "text",
"referenceId": "text",
"address": "text"
}
},
"expiredAt": "text",
"metadata": {
"description": "text"
}
},
"externalCheckout": {
"provider": "text",
"configuration": {
"currency": "text",
"amount": "text",
"reference": "text",
"redirectURL": "text",
"expirationTime": "text",
"description": "text"
},
"customer": {
"email": "text",
"fullName": "text",
"firstName": "text",
"lastName": "text",
"phoneNumber": "text",
"legalId": "text",
"legalIdType": "text"
},
"authentication": {
"publicKey": "text",
"token": "text"
},
"providerResponse": {
"providerCheckoutId": "text",
"checkoutURL": "text",
"sessionCode": "text",
"status": "text",
"additionalData": {}
},
"paymentMethod": {
"type": "text",
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"bank": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-06-23T03:34:58.351Z",
"updatedAt": "2025-06-23T03:34:58.351Z"
},
"wallet": {
"accountId": "text",
"provider": "text",
"referenceId": "text",
"address": "text"
}
}
},
"metadata": {
"image": "text",
"description": "text",
"category": "text"
}
}
],
"destinations": [
{
"name": "text",
"type": "text",
"externalId": "text",
"amount": "text",
"amountOut": "text",
"currency": "text",
"settlement": "text",
"fee": {
"name": "text",
"type": "text",
"value": "text",
"amount": "text",
"currency": "text"
},
"identity": {
"name": "text",
"documentNumber": "text",
"externalId": "text",
"lastname": "text"
},
"bank": {
"accountNumber": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text"
},
"account": {
"id": "text",
"identityId": "text",
"externalId": "text",
"type": "text",
"currency": "text",
"accountNumber": "text",
"accountHolder": "text",
"custodyBankAccount": {
"accountNumber": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"country": "text"
}
},
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"paymentInitiation": {
"type": "text",
"origin": "text",
"referenceId": "text",
"description": {
"title": "text",
"icon": "text",
"color": "text"
},
"url": "text",
"token": "text",
"minimumAmount": "text",
"maximumAmount": "text"
},
"paymentLink": {
"provider": "text",
"name": "text",
"payer": {
"name": "text",
"email": "text"
},
"paymentMethods": [
"text"
],
"paymentMethod": {
"type": "text",
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"bank": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-06-23T03:34:58.351Z",
"updatedAt": "2025-06-23T03:34:58.351Z"
},
"wallet": {
"accountId": "text",
"provider": "text",
"referenceId": "text",
"address": "text"
}
},
"expiredAt": "text",
"metadata": {
"description": "text"
}
},
"externalCheckout": {
"provider": "text",
"configuration": {
"currency": "text",
"amount": "text",
"reference": "text",
"redirectURL": "text",
"expirationTime": "text",
"description": "text"
},
"customer": {
"email": "text",
"fullName": "text",
"firstName": "text",
"lastName": "text",
"phoneNumber": "text",
"legalId": "text",
"legalIdType": "text"
},
"authentication": {
"publicKey": "text",
"token": "text"
},
"providerResponse": {
"providerCheckoutId": "text",
"checkoutURL": "text",
"sessionCode": "text",
"status": "text",
"additionalData": {}
},
"paymentMethod": {
"type": "text",
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"bank": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-06-23T03:34:58.351Z",
"updatedAt": "2025-06-23T03:34:58.351Z"
},
"wallet": {
"accountId": "text",
"provider": "text",
"referenceId": "text",
"address": "text"
}
}
},
"metadata": {
"image": "text",
"description": "text",
"category": "text"
}
}
],
"settlement": "text"
}This endpoint authorizes a transaction before it is captured, ensuring that the payment method has sufficient funds or credit availability. Authorization does not finalize the payment but reserves the amount until the capture is completed.
Authorizations
Path parameters
idstringRequired
Header parameters
x-api-keystringOptional
User-AgentstringOptional
Responses
200Success
application/json
400Error
application/json
500Error
application/json
post
POST /payments/{id}/authorized HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "text",
"externalId": "text",
"identityId": "text",
"identityExternalId": "text",
"accountNumber": "text",
"totalAmount": "text",
"currency": "text",
"description": "text",
"product": "text",
"status": "text",
"type": "P2P",
"purchaseAmount": "text",
"purchaseCurrency": "text",
"fees": [
{
"name": "text",
"type": "text",
"value": "text",
"amount": "text",
"currency": "text"
}
],
"createdAt": "text",
"updatedAt": "text",
"expiresAt": "text",
"capturedAt": "text",
"authorizedAt": "text",
"refundedAt": "text",
"origins": [
{
"name": "text",
"type": "text",
"externalId": "text",
"amount": "text",
"amountOut": "text",
"currency": "text",
"settlement": "text",
"fee": {
"name": "text",
"type": "text",
"value": "text",
"amount": "text",
"currency": "text"
},
"identity": {
"name": "text",
"documentNumber": "text",
"externalId": "text",
"lastname": "text"
},
"bank": {
"accountNumber": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text"
},
"account": {
"id": "text",
"identityId": "text",
"externalId": "text",
"type": "text",
"currency": "text",
"accountNumber": "text",
"accountHolder": "text",
"custodyBankAccount": {
"accountNumber": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"country": "text"
}
},
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"paymentInitiation": {
"type": "text",
"origin": "text",
"referenceId": "text",
"description": {
"title": "text",
"icon": "text",
"color": "text"
},
"url": "text",
"token": "text",
"minimumAmount": "text",
"maximumAmount": "text"
},
"paymentLink": {
"provider": "text",
"name": "text",
"payer": {
"name": "text",
"email": "text"
},
"paymentMethods": [
"text"
],
"paymentMethod": {
"type": "text",
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"bank": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-06-23T03:34:58.351Z",
"updatedAt": "2025-06-23T03:34:58.351Z"
},
"wallet": {
"accountId": "text",
"provider": "text",
"referenceId": "text",
"address": "text"
}
},
"expiredAt": "text",
"metadata": {
"description": "text"
}
},
"externalCheckout": {
"provider": "text",
"configuration": {
"currency": "text",
"amount": "text",
"reference": "text",
"redirectURL": "text",
"expirationTime": "text",
"description": "text"
},
"customer": {
"email": "text",
"fullName": "text",
"firstName": "text",
"lastName": "text",
"phoneNumber": "text",
"legalId": "text",
"legalIdType": "text"
},
"authentication": {
"publicKey": "text",
"token": "text"
},
"providerResponse": {
"providerCheckoutId": "text",
"checkoutURL": "text",
"sessionCode": "text",
"status": "text",
"additionalData": {}
},
"paymentMethod": {
"type": "text",
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"bank": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-06-23T03:34:58.351Z",
"updatedAt": "2025-06-23T03:34:58.351Z"
},
"wallet": {
"accountId": "text",
"provider": "text",
"referenceId": "text",
"address": "text"
}
}
},
"metadata": {
"image": "text",
"description": "text",
"category": "text"
}
}
],
"destinations": [
{
"name": "text",
"type": "text",
"externalId": "text",
"amount": "text",
"amountOut": "text",
"currency": "text",
"settlement": "text",
"fee": {
"name": "text",
"type": "text",
"value": "text",
"amount": "text",
"currency": "text"
},
"identity": {
"name": "text",
"documentNumber": "text",
"externalId": "text",
"lastname": "text"
},
"bank": {
"accountNumber": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text"
},
"account": {
"id": "text",
"identityId": "text",
"externalId": "text",
"type": "text",
"currency": "text",
"accountNumber": "text",
"accountHolder": "text",
"custodyBankAccount": {
"accountNumber": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"country": "text"
}
},
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"paymentInitiation": {
"type": "text",
"origin": "text",
"referenceId": "text",
"description": {
"title": "text",
"icon": "text",
"color": "text"
},
"url": "text",
"token": "text",
"minimumAmount": "text",
"maximumAmount": "text"
},
"paymentLink": {
"provider": "text",
"name": "text",
"payer": {
"name": "text",
"email": "text"
},
"paymentMethods": [
"text"
],
"paymentMethod": {
"type": "text",
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"bank": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-06-23T03:34:58.351Z",
"updatedAt": "2025-06-23T03:34:58.351Z"
},
"wallet": {
"accountId": "text",
"provider": "text",
"referenceId": "text",
"address": "text"
}
},
"expiredAt": "text",
"metadata": {
"description": "text"
}
},
"externalCheckout": {
"provider": "text",
"configuration": {
"currency": "text",
"amount": "text",
"reference": "text",
"redirectURL": "text",
"expirationTime": "text",
"description": "text"
},
"customer": {
"email": "text",
"fullName": "text",
"firstName": "text",
"lastName": "text",
"phoneNumber": "text",
"legalId": "text",
"legalIdType": "text"
},
"authentication": {
"publicKey": "text",
"token": "text"
},
"providerResponse": {
"providerCheckoutId": "text",
"checkoutURL": "text",
"sessionCode": "text",
"status": "text",
"additionalData": {}
},
"paymentMethod": {
"type": "text",
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"bank": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-06-23T03:34:58.351Z",
"updatedAt": "2025-06-23T03:34:58.351Z"
},
"wallet": {
"accountId": "text",
"provider": "text",
"referenceId": "text",
"address": "text"
}
}
},
"metadata": {
"image": "text",
"description": "text",
"category": "text"
}
}
],
"settlement": "text"
}Indicates that the payment has been successfully captured. At this stage, the transaction has been confirmed, and the funds have been debited from the payment source. However, the funds may still be in transit before being fully received.
Authorizations
Path parameters
idstringRequired
Header parameters
x-api-keystringOptional
User-AgentstringOptional
Responses
200Success
application/json
400Error
application/json
500Error
application/json
post
POST /payments/{id}/captured HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "text",
"externalId": "text",
"identityId": "text",
"identityExternalId": "text",
"accountNumber": "text",
"totalAmount": "text",
"currency": "text",
"description": "text",
"product": "text",
"status": "text",
"type": "P2P",
"purchaseAmount": "text",
"purchaseCurrency": "text",
"fees": [
{
"name": "text",
"type": "text",
"value": "text",
"amount": "text",
"currency": "text"
}
],
"createdAt": "text",
"updatedAt": "text",
"expiresAt": "text",
"capturedAt": "text",
"authorizedAt": "text",
"refundedAt": "text",
"origins": [
{
"name": "text",
"type": "text",
"externalId": "text",
"amount": "text",
"amountOut": "text",
"currency": "text",
"settlement": "text",
"fee": {
"name": "text",
"type": "text",
"value": "text",
"amount": "text",
"currency": "text"
},
"identity": {
"name": "text",
"documentNumber": "text",
"externalId": "text",
"lastname": "text"
},
"bank": {
"accountNumber": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text"
},
"account": {
"id": "text",
"identityId": "text",
"externalId": "text",
"type": "text",
"currency": "text",
"accountNumber": "text",
"accountHolder": "text",
"custodyBankAccount": {
"accountNumber": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"country": "text"
}
},
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"paymentInitiation": {
"type": "text",
"origin": "text",
"referenceId": "text",
"description": {
"title": "text",
"icon": "text",
"color": "text"
},
"url": "text",
"token": "text",
"minimumAmount": "text",
"maximumAmount": "text"
},
"paymentLink": {
"provider": "text",
"name": "text",
"payer": {
"name": "text",
"email": "text"
},
"paymentMethods": [
"text"
],
"paymentMethod": {
"type": "text",
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"bank": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-06-23T03:34:58.351Z",
"updatedAt": "2025-06-23T03:34:58.351Z"
},
"wallet": {
"accountId": "text",
"provider": "text",
"referenceId": "text",
"address": "text"
}
},
"expiredAt": "text",
"metadata": {
"description": "text"
}
},
"externalCheckout": {
"provider": "text",
"configuration": {
"currency": "text",
"amount": "text",
"reference": "text",
"redirectURL": "text",
"expirationTime": "text",
"description": "text"
},
"customer": {
"email": "text",
"fullName": "text",
"firstName": "text",
"lastName": "text",
"phoneNumber": "text",
"legalId": "text",
"legalIdType": "text"
},
"authentication": {
"publicKey": "text",
"token": "text"
},
"providerResponse": {
"providerCheckoutId": "text",
"checkoutURL": "text",
"sessionCode": "text",
"status": "text",
"additionalData": {}
},
"paymentMethod": {
"type": "text",
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"bank": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-06-23T03:34:58.351Z",
"updatedAt": "2025-06-23T03:34:58.351Z"
},
"wallet": {
"accountId": "text",
"provider": "text",
"referenceId": "text",
"address": "text"
}
}
},
"metadata": {
"image": "text",
"description": "text",
"category": "text"
}
}
],
"destinations": [
{
"name": "text",
"type": "text",
"externalId": "text",
"amount": "text",
"amountOut": "text",
"currency": "text",
"settlement": "text",
"fee": {
"name": "text",
"type": "text",
"value": "text",
"amount": "text",
"currency": "text"
},
"identity": {
"name": "text",
"documentNumber": "text",
"externalId": "text",
"lastname": "text"
},
"bank": {
"accountNumber": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text"
},
"account": {
"id": "text",
"identityId": "text",
"externalId": "text",
"type": "text",
"currency": "text",
"accountNumber": "text",
"accountHolder": "text",
"custodyBankAccount": {
"accountNumber": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"country": "text"
}
},
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"paymentInitiation": {
"type": "text",
"origin": "text",
"referenceId": "text",
"description": {
"title": "text",
"icon": "text",
"color": "text"
},
"url": "text",
"token": "text",
"minimumAmount": "text",
"maximumAmount": "text"
},
"paymentLink": {
"provider": "text",
"name": "text",
"payer": {
"name": "text",
"email": "text"
},
"paymentMethods": [
"text"
],
"paymentMethod": {
"type": "text",
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"bank": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-06-23T03:34:58.351Z",
"updatedAt": "2025-06-23T03:34:58.351Z"
},
"wallet": {
"accountId": "text",
"provider": "text",
"referenceId": "text",
"address": "text"
}
},
"expiredAt": "text",
"metadata": {
"description": "text"
}
},
"externalCheckout": {
"provider": "text",
"configuration": {
"currency": "text",
"amount": "text",
"reference": "text",
"redirectURL": "text",
"expirationTime": "text",
"description": "text"
},
"customer": {
"email": "text",
"fullName": "text",
"firstName": "text",
"lastName": "text",
"phoneNumber": "text",
"legalId": "text",
"legalIdType": "text"
},
"authentication": {
"publicKey": "text",
"token": "text"
},
"providerResponse": {
"providerCheckoutId": "text",
"checkoutURL": "text",
"sessionCode": "text",
"status": "text",
"additionalData": {}
},
"paymentMethod": {
"type": "text",
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"bank": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-06-23T03:34:58.351Z",
"updatedAt": "2025-06-23T03:34:58.351Z"
},
"wallet": {
"accountId": "text",
"provider": "text",
"referenceId": "text",
"address": "text"
}
}
},
"metadata": {
"image": "text",
"description": "text",
"category": "text"
}
}
],
"settlement": "text"
}Authorizations
Path parameters
idstringRequired
Query parameters
typestringOptional
productstringOptional
statusstringOptional
countrystringOptional
Responses
200Success
application/json
get
GET /payments/{id} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
[
{
"id": "text",
"externalId": "text",
"identityId": "text",
"identityExternalId": "text",
"accountNumber": "text",
"totalAmount": "text",
"currency": "text",
"description": "text",
"product": "text",
"status": "text",
"type": "P2P",
"purchaseAmount": "text",
"purchaseCurrency": "text",
"fees": [
{
"name": "text",
"type": "text",
"value": "text",
"amount": "text",
"currency": "text"
}
],
"createdAt": "text",
"updatedAt": "text",
"expiresAt": "text",
"capturedAt": "text",
"authorizedAt": "text",
"refundedAt": "text",
"origins": [
{
"name": "text",
"type": "text",
"externalId": "text",
"amount": "text",
"amountOut": "text",
"currency": "text",
"settlement": "text",
"fee": {
"name": "text",
"type": "text",
"value": "text",
"amount": "text",
"currency": "text"
},
"identity": {
"name": "text",
"documentNumber": "text",
"externalId": "text",
"lastname": "text"
},
"bank": {
"accountNumber": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text"
},
"account": {
"id": "text",
"identityId": "text",
"externalId": "text",
"type": "text",
"currency": "text",
"accountNumber": "text",
"accountHolder": "text",
"custodyBankAccount": {
"accountNumber": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"country": "text"
}
},
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"paymentInitiation": {
"type": "text",
"origin": "text",
"referenceId": "text",
"description": {
"title": "text",
"icon": "text",
"color": "text"
},
"url": "text",
"token": "text",
"minimumAmount": "text",
"maximumAmount": "text"
},
"paymentLink": {
"provider": "text",
"name": "text",
"payer": {
"name": "text",
"email": "text"
},
"paymentMethods": [
"text"
],
"paymentMethod": {
"type": "text",
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"bank": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-06-23T03:34:58.351Z",
"updatedAt": "2025-06-23T03:34:58.351Z"
},
"wallet": {
"accountId": "text",
"provider": "text",
"referenceId": "text",
"address": "text"
}
},
"expiredAt": "text",
"metadata": {
"description": "text"
}
},
"externalCheckout": {
"provider": "text",
"configuration": {
"currency": "text",
"amount": "text",
"reference": "text",
"redirectURL": "text",
"expirationTime": "text",
"description": "text"
},
"customer": {
"email": "text",
"fullName": "text",
"firstName": "text",
"lastName": "text",
"phoneNumber": "text",
"legalId": "text",
"legalIdType": "text"
},
"authentication": {
"publicKey": "text",
"token": "text"
},
"providerResponse": {
"providerCheckoutId": "text",
"checkoutURL": "text",
"sessionCode": "text",
"status": "text",
"additionalData": {}
},
"paymentMethod": {
"type": "text",
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"bank": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-06-23T03:34:58.351Z",
"updatedAt": "2025-06-23T03:34:58.351Z"
},
"wallet": {
"accountId": "text",
"provider": "text",
"referenceId": "text",
"address": "text"
}
}
},
"metadata": {
"image": "text",
"description": "text",
"category": "text"
}
}
],
"destinations": [
{
"name": "text",
"type": "text",
"externalId": "text",
"amount": "text",
"amountOut": "text",
"currency": "text",
"settlement": "text",
"fee": {
"name": "text",
"type": "text",
"value": "text",
"amount": "text",
"currency": "text"
},
"identity": {
"name": "text",
"documentNumber": "text",
"externalId": "text",
"lastname": "text"
},
"bank": {
"accountNumber": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text"
},
"account": {
"id": "text",
"identityId": "text",
"externalId": "text",
"type": "text",
"currency": "text",
"accountNumber": "text",
"accountHolder": "text",
"custodyBankAccount": {
"accountNumber": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"country": "text"
}
},
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"paymentInitiation": {
"type": "text",
"origin": "text",
"referenceId": "text",
"description": {
"title": "text",
"icon": "text",
"color": "text"
},
"url": "text",
"token": "text",
"minimumAmount": "text",
"maximumAmount": "text"
},
"paymentLink": {
"provider": "text",
"name": "text",
"payer": {
"name": "text",
"email": "text"
},
"paymentMethods": [
"text"
],
"paymentMethod": {
"type": "text",
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"bank": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-06-23T03:34:58.351Z",
"updatedAt": "2025-06-23T03:34:58.351Z"
},
"wallet": {
"accountId": "text",
"provider": "text",
"referenceId": "text",
"address": "text"
}
},
"expiredAt": "text",
"metadata": {
"description": "text"
}
},
"externalCheckout": {
"provider": "text",
"configuration": {
"currency": "text",
"amount": "text",
"reference": "text",
"redirectURL": "text",
"expirationTime": "text",
"description": "text"
},
"customer": {
"email": "text",
"fullName": "text",
"firstName": "text",
"lastName": "text",
"phoneNumber": "text",
"legalId": "text",
"legalIdType": "text"
},
"authentication": {
"publicKey": "text",
"token": "text"
},
"providerResponse": {
"providerCheckoutId": "text",
"checkoutURL": "text",
"sessionCode": "text",
"status": "text",
"additionalData": {}
},
"paymentMethod": {
"type": "text",
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"bank": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-06-23T03:34:58.351Z",
"updatedAt": "2025-06-23T03:34:58.351Z"
},
"wallet": {
"accountId": "text",
"provider": "text",
"referenceId": "text",
"address": "text"
}
}
},
"metadata": {
"image": "text",
"description": "text",
"category": "text"
}
}
],
"settlement": "text"
}
]Indicates that the funds have been received and are available in the destination account. This represents the final stage of the payment process, where the funds are no longer in transit and can be used.
Authorizations
Header parameters
x-api-keystringRequired
User-AgentstringRequired
Body
transactionIdstringRequired
transaction id
signaturestringRequired
provider signature
Responses
200Success
application/json
post
POST /payments/received HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Content-Type: application/json
Accept: */*
Content-Length: 30
{
"id": "YNgma4fqAjwIftRM5Za6D"
}200Success
{
"id": "text",
"externalId": "text",
"identityId": "text",
"identityExternalId": "text",
"accountNumber": "text",
"totalAmount": "text",
"currency": "text",
"description": "text",
"product": "text",
"status": "text",
"type": "P2P",
"purchaseAmount": "text",
"purchaseCurrency": "text",
"fees": [
{
"name": "text",
"type": "text",
"value": "text",
"amount": "text",
"currency": "text"
}
],
"createdAt": "text",
"updatedAt": "text",
"expiresAt": "text",
"capturedAt": "text",
"authorizedAt": "text",
"refundedAt": "text",
"origins": [
{
"name": "text",
"type": "text",
"externalId": "text",
"amount": "text",
"amountOut": "text",
"currency": "text",
"settlement": "text",
"fee": {
"name": "text",
"type": "text",
"value": "text",
"amount": "text",
"currency": "text"
},
"identity": {
"name": "text",
"documentNumber": "text",
"externalId": "text",
"lastname": "text"
},
"bank": {
"accountNumber": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text"
},
"account": {
"id": "text",
"identityId": "text",
"externalId": "text",
"type": "text",
"currency": "text",
"accountNumber": "text",
"accountHolder": "text",
"custodyBankAccount": {
"accountNumber": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"country": "text"
}
},
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"paymentInitiation": {
"type": "text",
"origin": "text",
"referenceId": "text",
"description": {
"title": "text",
"icon": "text",
"color": "text"
},
"url": "text",
"token": "text",
"minimumAmount": "text",
"maximumAmount": "text"
},
"paymentLink": {
"provider": "text",
"name": "text",
"payer": {
"name": "text",
"email": "text"
},
"paymentMethods": [
"text"
],
"paymentMethod": {
"type": "text",
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"bank": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-06-23T03:34:58.351Z",
"updatedAt": "2025-06-23T03:34:58.351Z"
},
"wallet": {
"accountId": "text",
"provider": "text",
"referenceId": "text",
"address": "text"
}
},
"expiredAt": "text",
"metadata": {
"description": "text"
}
},
"externalCheckout": {
"provider": "text",
"configuration": {
"currency": "text",
"amount": "text",
"reference": "text",
"redirectURL": "text",
"expirationTime": "text",
"description": "text"
},
"customer": {
"email": "text",
"fullName": "text",
"firstName": "text",
"lastName": "text",
"phoneNumber": "text",
"legalId": "text",
"legalIdType": "text"
},
"authentication": {
"publicKey": "text",
"token": "text"
},
"providerResponse": {
"providerCheckoutId": "text",
"checkoutURL": "text",
"sessionCode": "text",
"status": "text",
"additionalData": {}
},
"paymentMethod": {
"type": "text",
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"bank": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-06-23T03:34:58.351Z",
"updatedAt": "2025-06-23T03:34:58.351Z"
},
"wallet": {
"accountId": "text",
"provider": "text",
"referenceId": "text",
"address": "text"
}
}
},
"metadata": {
"image": "text",
"description": "text",
"category": "text"
}
}
],
"destinations": [
{
"name": "text",
"type": "text",
"externalId": "text",
"amount": "text",
"amountOut": "text",
"currency": "text",
"settlement": "text",
"fee": {
"name": "text",
"type": "text",
"value": "text",
"amount": "text",
"currency": "text"
},
"identity": {
"name": "text",
"documentNumber": "text",
"externalId": "text",
"lastname": "text"
},
"bank": {
"accountNumber": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text"
},
"account": {
"id": "text",
"identityId": "text",
"externalId": "text",
"type": "text",
"currency": "text",
"accountNumber": "text",
"accountHolder": "text",
"custodyBankAccount": {
"accountNumber": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"country": "text"
}
},
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"paymentInitiation": {
"type": "text",
"origin": "text",
"referenceId": "text",
"description": {
"title": "text",
"icon": "text",
"color": "text"
},
"url": "text",
"token": "text",
"minimumAmount": "text",
"maximumAmount": "text"
},
"paymentLink": {
"provider": "text",
"name": "text",
"payer": {
"name": "text",
"email": "text"
},
"paymentMethods": [
"text"
],
"paymentMethod": {
"type": "text",
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"bank": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-06-23T03:34:58.351Z",
"updatedAt": "2025-06-23T03:34:58.351Z"
},
"wallet": {
"accountId": "text",
"provider": "text",
"referenceId": "text",
"address": "text"
}
},
"expiredAt": "text",
"metadata": {
"description": "text"
}
},
"externalCheckout": {
"provider": "text",
"configuration": {
"currency": "text",
"amount": "text",
"reference": "text",
"redirectURL": "text",
"expirationTime": "text",
"description": "text"
},
"customer": {
"email": "text",
"fullName": "text",
"firstName": "text",
"lastName": "text",
"phoneNumber": "text",
"legalId": "text",
"legalIdType": "text"
},
"authentication": {
"publicKey": "text",
"token": "text"
},
"providerResponse": {
"providerCheckoutId": "text",
"checkoutURL": "text",
"sessionCode": "text",
"status": "text",
"additionalData": {}
},
"paymentMethod": {
"type": "text",
"card": {
"number": "text",
"holder": "text",
"expiryMonth": "text",
"expiryYear": "text",
"brand": "text",
"cardType": "text",
"last4": "text",
"country": "text"
},
"bank": {
"id": "text",
"externalId": "text",
"accountNumber": "text",
"nickname": "text",
"bank": "text",
"currency": "text",
"typeAccount": "text",
"accountHolder": "text",
"accountHolderDni": "text",
"country": "text",
"createdAt": "2025-06-23T03:34:58.351Z",
"updatedAt": "2025-06-23T03:34:58.351Z"
},
"wallet": {
"accountId": "text",
"provider": "text",
"referenceId": "text",
"address": "text"
}
}
},
"metadata": {
"image": "text",
"description": "text",
"category": "text"
}
}
],
"settlement": "text"
}Webhook to notify about the transaction status updates. Will notify 3 possible states: CAPTURED, RECEIVED,FAILED
Signature Format Algorithm: HMAC-SHA256 Length: 64-character hexadecimal string Computation: The signature is generated by hashing the full JSON body (excluding the signature field) using HMAC-SHA256 with the secret key.
Signature Generation Example (Node.js) Before sending the webhook, the signature must be computed:
const crypto = require('crypto');
const secret = "WEBHOOK_SECRET"; // Shared secret key
const payload = JSON.stringify({ event: "Transaction.Captured", data: { transaction: { id: "67a0307eaddea901a60144ec", purchaseAmount: "50000", totalAmount: "50000", externalId: "123456", currency: "COP", status: "CAPTURED" } } });
// Generate HMAC-SHA256 signature const signature = crypto .createHmac('sha256', secret) .update(payload) .digest('hex');
// Add the signature to the payload const signedPayload = { ...JSON.parse(payload), signature };
console.log(signedPayload);
Authorizations
Responses
200Success
application/json
post
POST /client-url HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
"event": "Transaction.Captured",
"data": {
"transaction": {
"id": "67a0307eaddea901a60144ec",
"purchaseAmount": "50000",
"totalAmount": "50000",
"externalId": "{{CLIENT_TRANSACTION_ID}}",
"currency": "COP",
"status": "CAPTURED"
}
},
"signature": "f8a23d5e0c7c2b6e4a8f9d0c5b3d7e1a7f6c4e2d9b0a5f8c3e1d6b9a7c4e2d1f"
}