Get Payment Method

Retrieves a Payment Method using the ID specified.

Authorizations

Authorization

string

headerrequired

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

Path Parameters

paymentMethodId

string

required

Unique identifier of the payment method.

Response

200 - application/json

id

string

Unique identifier for this payment method.

status

enum<string>

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.

Available options:

pending,

active,

error

customerId

string

Reference to the customer who owns this payment method.

customerDetails

object

Show child attributes

type

enum<string>

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.

Available options:

bankAccount,

bancolombiaInstant,

nequiInstant

bankAccount

object

Show child attributes

bancolombiaInstant

object

Show child attributes

nequiInstant

object

Show child attributes

createdAt

string

ISO string when the payment method was created.

updatedAt

string

ISO string when the payment method was last updated.