POST
/
paymentMethods

Authorizations

Authorization
string
headerrequired

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

Body

application/json
customerId
string
required

Unique identifier of the customer.

type
enum<string>
required
Available options:
bankAccount
bank
enum<string>
required

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
accountType
enum<string>
required

Type of bank account (savings or checking).

Available options:
savings,
checking
accountNumber
string
required

Bank account number.

Response

201 - 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
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
bancolombiaInstant
object
nequiInstant
object
createdAt
string

ISO string when the payment method was created.

updatedAt
string

ISO string when the payment method was last updated.