Get All Payment Requests

List Payment Requests

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": "[email protected]"
      },
      "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": "*1234"
          }
        },
        "nequiInstant": {
          "phoneNumber": "3298779391"
        }
      },
      "currency": "cop",
      "amount": 10000,
      "createdAt": "“2023-10-26T21:28:34.152Z”",
      "updatedAt": "“2023-10-26T21:28:34.152Z”",
      "approvedDetails": {
        "approvedAt": "2023-10-26T21:28:34.152Z",
        "paidAt": "2023-10-26T21:28:34.152Z"
      },
      "errorDetails": {
        "errorCode": "D23",
        "errorMessage": "Not enough funds",
        "errorAt": "“2023-10-26T21:28:34.152Z”"
      }
    }
  ]
}

GET

paymentRequests

List Payment Requests

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": "[email protected]"
      },
      "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": "*1234"
          }
        },
        "nequiInstant": {
          "phoneNumber": "3298779391"
        }
      },
      "currency": "cop",
      "amount": 10000,
      "createdAt": "“2023-10-26T21:28:34.152Z”",
      "updatedAt": "“2023-10-26T21:28:34.152Z”",
      "approvedDetails": {
        "approvedAt": "2023-10-26T21:28:34.152Z",
        "paidAt": "2023-10-26T21:28:34.152Z"
      },
      "errorDetails": {
        "errorCode": "D23",
        "errorMessage": "Not enough funds",
        "errorAt": "“2023-10-26T21:28:34.152Z”"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

A list of payment requests.

items

object[]

Show child attributes

items.id

string<uuid>

Unique identifier for this payment request.

Example:

"0697129c-26e2-42f1-a000-dc60878d5588"

items.status

enum<string>

Current status of the payment request.

Available options:

pending,

processing,

approved,

error

Example:

"approved"

items.customerId

string

Reference to the customer who owns the payment method from which the payment request was created.

Example:

"e79a0b74-3aba-4149-9f74-0bb5791a6ee6"

items.customerDetails

object

Show child attributes

items.customerDetails.name

string

First and last name for a natural person, and company name for a juridical person.

Example:

"Pepito Perez"

items.customerDetails.documentType

enum<string>

Colombian ID type for customer.

Available options:

cc,

ce,

nit

Example:

"cc"

items.customerDetails.documentNumber

string

Colombian ID number for customer.

Example:

"200220422"

items.customerDetails.email

string

Customer’s email.

Example:

"[email protected]"

items.paymentMethodId

string

Reference to the payment method from which the payment request was created.

Example:

"67d7ae28-bf1d-4ee9-8a47-99358c9e6c32"

items.paymentMethodDetails

object

Show child attributes

items.paymentMethodDetails.type

enum<string>

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.

Available options:

bankAccount,

bancolombiaInstant,

nequiInstant

Example:

"bankAccount"

items.paymentMethodDetails.bankAccount

object

Show child attributes

items.paymentMethodDetails.bankAccount.bank

enum<string>

Enum of all available banks for direct debit through the Palomma API.

Available options:

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

items.paymentMethodDetails.bankAccount.accountType

enum<string>

Account type for payment method.

Available options:

savings,

checking

Example:

"savings"

items.paymentMethodDetails.bankAccount.accountNumber

string

Account number for payment method.

Example:

"123456789"

items.paymentMethodDetails.bancolombiaInstant

object

Information about the Bancolombia account associated to this payment method. Only present when payment method type is "bancolombiaInstant".

Show child attributes

items.paymentMethodDetails.bancolombiaInstant.affiliate

object

Show child attributes

items.paymentMethodDetails.bancolombiaInstant.affiliate.name

string

Name of the linked Bancolombia account owner.

Example:

"Pepito Perez"

items.paymentMethodDetails.bancolombiaInstant.affiliate.documentType

string

Document type for linked Bancolombia account owner.

Example:

"cc"

items.paymentMethodDetails.bancolombiaInstant.affiliate.documentNumber

string

Document number for linked Bancolombia account owner.

Example:

"200220422"

items.paymentMethodDetails.bancolombiaInstant.affiliate.accountType

string

Account type for linked Bancolombia account.

Example:

"savings"

items.paymentMethodDetails.bancolombiaInstant.affiliate.accountNumber

string

Last four digits of account number for linked Bancolombia account.

Example:

"*1234"

items.paymentMethodDetails.nequiInstant

object

Information about the Nequi account associated to this payment method. Only present when payment method type is "nequiInstant".

Show child attributes

items.paymentMethodDetails.nequiInstant.phoneNumber

string

Example:

"3298779391"

items.currency

string

Always "cop" (Colombian Pesos).

Example:

"cop"

items.amount

number

Amount to collect from the customer's payment method, with no more than two decimal places.

Example:

10000

items.createdAt

string<date-time>

ISO string when the payment request was created.

Example:

"“2023-10-26T21:28:34.152Z”"

items.updatedAt

string<date-time>

ISO string when the payment request was last updated.

Example:

"“2023-10-26T21:28:34.152Z”"

items.approvedDetails

object

Show child attributes

items.approvedDetails.approvedAt

string<date-time>

ISO string when the payment request was approved.

Example:

"2023-10-26T21:28:34.152Z"

items.approvedDetails.paidAt

string<date-time>

ISO string when the payment request was paid out to the merchant, or null for unpaid transactions.

Example:

"2023-10-26T21:28:34.152Z"

items.errorDetails

object

Show child attributes

items.errorDetails.errorCode

string

Error code returned by financial institution that processed the transaction.

Example:

"D23"

items.errorDetails.errorMessage

string

Description of the error in the transaction from the processing financial institution.

Example:

"Not enough funds"

items.errorDetails.errorAt

string<date-time>

ISO string when the payment request resolved to an error.

Example:

"“2023-10-26T21:28:34.152Z”"

Create Payment Request Get Payment Request

⌘I

General

API Documentation

Webhooks

Get All Payment Requests

Authorizations

Response