General
API Documentation
- Introduction
- Endpoints
- Customers
- Payment Methods
- Payment Requests
Webhooks
Get All Payment Methods
Returns a list of all Payment Method objects corresponding to the merchant.
curl --request GET \
--url https://prod.api.palomma.com/v1/paymentMethods \
--header 'Authorization: Bearer <token>'{
"items": [
{
"id": "67d7ae28-bf1d-4ee9-8a47-99358c9e6c32",
"status": "active",
"customerId": "e79a0b74-3aba-4149-9f74-0bb5791a6ee6",
"customerDetails": {
"name": "Pepito Perez",
"documentType": "cc",
"documentNumber": "200220422",
"email": "pepito@perez.com"
},
"type": "bankAccount",
"bankAccount": {
"bank": "santander",
"accountType": "savings",
"accountNumber": "123456789"
},
"bancolombiaInstant": {
"authUrl": "https://www.bancolombia.com/...",
"affiliate": {
"name": "Pepito Perez",
"documentType": "cc",
"documentNumber": "200220422",
"accountType": "savings",
"accountNumber": "123456789"
}
},
"nequiInstant": {
"phoneNumber": "3298779391"
},
"createdAt": "2023-10-26T21:28:34.152Z",
"updatedAt": "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 method.
"67d7ae28-bf1d-4ee9-8a47-99358c9e6c32"
Status of the payment method. 'pending' indicates the payment method is not yet available for payment requests. 'active' indicates the payment method is available for payment requests. 'error' indicates an error confirming the bank account, usually when bank info is incorrect or customer info doesn’t match with the bank account owner’s.
pending, active, error "active"
Reference to the customer who owns this payment method.
"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"
Type of payment method created. Can be "bankAccount" for an account that transacts through traditional slower banking rails, "bancolombiaInstant", or "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"
Link for authorization. Only available while payment method status is "pending".
"https://www.bancolombia.com/..."
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"
Account number for linked Nequi Account.
"3298779391"
ISO string when the payment method was created.
"2023-10-26T21:28:34.152Z"
ISO string when the payment method was last updated.
"2023-10-26T21:28:34.152Z"
curl --request GET \
--url https://prod.api.palomma.com/v1/paymentMethods \
--header 'Authorization: Bearer <token>'{
"items": [
{
"id": "67d7ae28-bf1d-4ee9-8a47-99358c9e6c32",
"status": "active",
"customerId": "e79a0b74-3aba-4149-9f74-0bb5791a6ee6",
"customerDetails": {
"name": "Pepito Perez",
"documentType": "cc",
"documentNumber": "200220422",
"email": "pepito@perez.com"
},
"type": "bankAccount",
"bankAccount": {
"bank": "santander",
"accountType": "savings",
"accountNumber": "123456789"
},
"bancolombiaInstant": {
"authUrl": "https://www.bancolombia.com/...",
"affiliate": {
"name": "Pepito Perez",
"documentType": "cc",
"documentNumber": "200220422",
"accountType": "savings",
"accountNumber": "123456789"
}
},
"nequiInstant": {
"phoneNumber": "3298779391"
},
"createdAt": "2023-10-26T21:28:34.152Z",
"updatedAt": "2023-10-26T21:28:34.152Z"
}
]
}