General
API Documentation
- Introduction
- Endpoints
- Customers
- Payment Methods
- Payment Requests
Webhooks
Get All Payment Requests
Returns a list of all Payment Request objects corresponding to the merchant.
curl --request GET \
--url https://prod.api.palomma.com/v1/paymentRequests \
--header 'Authorization: Bearer <token>'{
"items": [
{
"id": "0697129c-26e2-42f1-a000-dc60878d5588",
"status": "approved",
"customerId": "e79a0b74-3aba-4149-9f74-0bb5791a6ee6",
"customerDetails": {
"name": "Pepito Perez",
"documentType": "cc",
"documentNumber": "200220422",
"email": "pepito@perez.com"
},
"paymentMethodId": "67d7ae28-bf1d-4ee9-8a47-99358c9e6c32",
"paymentMethodDetails": {
"type": "bankAccount",
"bankAccount": {
"bank": "santander",
"accountType": "savings",
"accountNumber": "123456789"
},
"bancolombiaInstant": {
"affiliate": {
"name": "Pepito Perez",
"documentType": "cc",
"documentNumber": "200220422",
"accountType": "savings",
"accountNumber": "123456789"
}
},
"nequiInstant": {
"phoneNumber": "3298779391"
}
},
"currency": "cop",
"amount": 10000,
"createdAt": "“2023-10-26T21:28:34.152Z”",
"updatedAt": "“2023-10-26T21:28:34.152Z”",
"approvedDetails": {
"status": "approved",
"approvedAt": "2023-10-26T21:28:34.152Z",
"paidAt": "2023-10-26T21:28:34.152Z"
},
"errorDetails": {
"status": "error",
"errorCode": "D23",
"errorMessage": "Not enough funds",
"errorAt": "“2023-10-26T21:28:34.152Z”"
}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
Unique identifier for this payment request.
"0697129c-26e2-42f1-a000-dc60878d5588"
Current status of the payment request.
pending, processing, approved, error "approved"
Reference to the customer who owns the payment method from which the payment request was created.
"e79a0b74-3aba-4149-9f74-0bb5791a6ee6"
First and last name for a natural person, and company name for a juridical person.
"Pepito Perez"
Colombian ID type for customer.
cc, ce, nit "cc"
Colombian ID number for customer.
"200220422"
Customer’s email.
"pepito@perez.com"
Reference to the payment method from which the payment request was created.
"67d7ae28-bf1d-4ee9-8a47-99358c9e6c32"
Type of payment method created. Can be "bankAccount" for an account that transacts through traditional slower banking rails, or "bancolombiaInstant", "nequiInstant" for tokenized instant payment accounts.
bankAccount, bancolombiaInstant, nequiInstant "bankAccount"
Enum of all available banks for direct debit through the Palomma API.
santander, coofinep, avvillas, cotrafa, confiar, union, nequi, bancoagrario, bancoomeva, bancamia, coopcentral, citibank, bancodeoccidente, falabella, bancodebogota, bancocajasocial, serfinanza, cfa, coltefinanciera, pichincha, iris, ban100, bancopopular, daviplata, bancolombia, finandina, scotiabankcolpatria, gnbsudameris, itau, bbva, davivienda, mibanco, multibank, mundomujer, procreditcolombia, bancow, bancoldex, juriscoop, itauhelm, jpmorgancolombia Account type for payment method.
savings, checking "savings"
Account number for payment method.
"123456789"
Information about the Bancolombia account associated to this payment method. Only present when payment method type is "bancolombiaInstant".
Name of the linked Bancolombia account owner.
"Pepito Perez"
Document type for linked Bancolombia account owner.
"cc"
Document number for linked Bancolombia account owner.
"200220422"
Account type for linked Bancolombia account.
"savings"
Last four digits of account number for linked Bancolombia account.
"123456789"
Always "cop" (Colombian Pesos).
"cop"
Amount to collect from the customer's payment method, with no more than two decimal places.
10000
ISO string when the payment request was created.
"“2023-10-26T21:28:34.152Z”"
ISO string when the payment request was last updated.
"“2023-10-26T21:28:34.152Z”"
Indicates the payment request is approved.
approved "approved"
ISO string when the payment request was approved.
"2023-10-26T21:28:34.152Z"
ISO string when the payment request was paid out to the merchant, or null for unpaid transactions.
"2023-10-26T21:28:34.152Z"
Indicates the payment request resulted in an error.
error "error"
Error code returned by financial institution that processed the transaction.
"D23"
Description of the error in the transaction from the processing financial institution.
"Not enough funds"
ISO string when the payment request resolved to an error.
"“2023-10-26T21:28:34.152Z”"
curl --request GET \
--url https://prod.api.palomma.com/v1/paymentRequests \
--header 'Authorization: Bearer <token>'{
"items": [
{
"id": "0697129c-26e2-42f1-a000-dc60878d5588",
"status": "approved",
"customerId": "e79a0b74-3aba-4149-9f74-0bb5791a6ee6",
"customerDetails": {
"name": "Pepito Perez",
"documentType": "cc",
"documentNumber": "200220422",
"email": "pepito@perez.com"
},
"paymentMethodId": "67d7ae28-bf1d-4ee9-8a47-99358c9e6c32",
"paymentMethodDetails": {
"type": "bankAccount",
"bankAccount": {
"bank": "santander",
"accountType": "savings",
"accountNumber": "123456789"
},
"bancolombiaInstant": {
"affiliate": {
"name": "Pepito Perez",
"documentType": "cc",
"documentNumber": "200220422",
"accountType": "savings",
"accountNumber": "123456789"
}
},
"nequiInstant": {
"phoneNumber": "3298779391"
}
},
"currency": "cop",
"amount": 10000,
"createdAt": "“2023-10-26T21:28:34.152Z”",
"updatedAt": "“2023-10-26T21:28:34.152Z”",
"approvedDetails": {
"status": "approved",
"approvedAt": "2023-10-26T21:28:34.152Z",
"paidAt": "2023-10-26T21:28:34.152Z"
},
"errorDetails": {
"status": "error",
"errorCode": "D23",
"errorMessage": "Not enough funds",
"errorAt": "“2023-10-26T21:28:34.152Z”"
}
}
]
}