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

Payment Request retrieved successfully.

id

string

Unique identifier for this payment request.

Example:

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

status

enum<string>

Current status of the payment request.

Available options:

pending,

processing,

approved,

error

Example:

"approved"

customerId

string

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

Example:

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

customerDetails

object

Show child attributes

customerDetails.name

string

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

Example:

"Pepito Perez"

customerDetails.documentType

enum<string>

Colombian ID type for customer.

Available options:

cc,

ce,

nit

Example:

"cc"

customerDetails.documentNumber

string

Colombian ID number for customer.

Example:

"200220422"

customerDetails.email

string

Customer’s email.

Example:

"[e-mail]"

paymentMethodId

string

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

Example:

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

paymentMethodDetails

object

Show child attributes

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"

paymentMethodDetails.bankAccount

object

Show child attributes

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.bankAccount.accountType

enum<string>

Account type for payment method.

Available options:

savings,

checking

Example:

"savings"

paymentMethodDetails.bankAccount.accountNumber

string

Account number for payment method.

Example:

"123456789"

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.name

string

Name of the linked Bancolombia account owner.

Example:

"Pepito Perez"

paymentMethodDetails.bancolombiaInstant.affiliate.documentType

string

Document type for linked Bancolombia account owner.

Example:

"cc"

paymentMethodDetails.bancolombiaInstant.affiliate.documentNumber

string

Document number for linked Bancolombia account owner.

Example:

"200220422"

paymentMethodDetails.bancolombiaInstant.affiliate.accountType

string

Account type for linked Bancolombia account.

Example:

"savings"

paymentMethodDetails.bancolombiaInstant.affiliate.accountNumber

string

Last four digits of account number for linked Bancolombia account.

Example:

"123456789"

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

Example:

"3298779391"

currency

string

Always "cop" (Colombian Pesos).

Example:

"cop"

amount

number

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

Example:

10000

createdAt

string

ISO string when the payment request was created.

Example:

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

updatedAt

string

ISO string when the payment request was last updated.

Example:

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

approvedDetails

object

Show child attributes

approvedDetails.status

enum<string>

Indicates the payment request is approved.

Available options:

approved

Example:

"approved"

approvedDetails.approvedAt

string

ISO string when the payment request was approved.

Example:

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

approvedDetails.paidAt

string

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

Example:

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

errorDetails

object

Show child attributes

errorDetails.status

enum<string>

Indicates the payment request resulted in an error.

Available options:

error

Example:

"error"

errorDetails.errorCode

string

Error code returned by financial institution that processed the transaction.

Example:

"D23"

errorDetails.errorMessage

string

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

Example:

"Not enough funds"

errorDetails.errorAt

string

ISO string when the payment request resolved to an error.

Example:

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