Get Payment Request

Retrieves a Payment Request using the ID specified.

Authorizations

Authorization

string

header

required

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

Path Parameters

paymentRequestId

string

required

Unique identifier of the payment request.

Response

200 - application/json

amount

number

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

approvedDetails

object

Show child attributes

approvedDetails.approvedAt

string

ISO string when the payment request was approved.

approvedDetails.paidAt

string

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

approvedDetails.status

enum<string>

Indicates the payment request is approved.

Available options:

approved

createdAt

string

ISO string when the payment request was created.

currency

string

Always "cop" (Colombian Pesos).

customerDetails

object

Show child attributes

customerDetails.documentNumber

string

Colombian ID number for customer.

customerDetails.documentType

enum<string>

Colombian ID type for customer.

Available options:

cc,

ce,

nit

customerDetails.email

string

Customer’s email.

customerDetails.name

string

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

customerId

string

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

errorDetails

object

Show child attributes

errorDetails.errorAt

string

ISO string when the payment request resolved to an error.

errorDetails.errorCode

string

Error code returned by financial institution that processed the transaction.

errorDetails.errorMessage

string

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

errorDetails.status

enum<string>

Indicates the payment request resulted in an error.

Available options:

error

id

string

Unique identifier for this payment request.

paymentMethodDetails

object

Show child attributes

paymentMethodDetails.bancolombiaInstant

object | null

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

Show child attributes

paymentMethodDetails.bancolombiaInstant.affiliate

object

Show child attributes

paymentMethodDetails.bancolombiaInstant.affiliate.accountNumber

string

Last four digits of account number for linked Bancolombia account.

paymentMethodDetails.bancolombiaInstant.affiliate.accountType

string

Account type for linked Bancolombia account.

paymentMethodDetails.bancolombiaInstant.affiliate.documentNumber

string

Document number for linked Bancolombia account owner.

paymentMethodDetails.bancolombiaInstant.affiliate.documentType

string

Document type for linked Bancolombia account owner.

paymentMethodDetails.bancolombiaInstant.affiliate.name

string

Name of the linked Bancolombia account owner.

paymentMethodDetails.bankAccount

object

Show child attributes

paymentMethodDetails.bankAccount.accountNumber

string

Account number for payment method.

paymentMethodDetails.bankAccount.accountType

enum<string>

Account type for payment method.

Available options:

savings,

checking

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

paymentMethodDetails.nequiInstant

object | null

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

Show child attributes

paymentMethodDetails.nequiInstant.phoneNumber

string

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

paymentMethodId

string

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

status

enum<string>

Current status of the payment request.

Available options:

pending,

processing,

approved,

error

updatedAt

string

ISO string when the payment request was last updated.