Create Payment Method

Creates a new Payment Method from the information sent in the body.

Authorizations

Authorization

string

header

required

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

Body

application/json

• Option 1
• Option 2
• Option 3

accountNumber

string

required

Bank account number.

accountType

enum<string>

required

Type of bank account (savings or checking).

Available options:

savings,

checking

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

customerId

string

required

Unique identifier of the customer.

type

enum<string>

required

Available options:

bankAccount

Response

201 - application/json

bancolombiaInstant

object

Show child attributes

bancolombiaInstant.affiliate

object

Show child attributes

bancolombiaInstant.affiliate.accountNumber

string

Last four digits of account number for linked Bancolombia account.

bancolombiaInstant.affiliate.accountType

string

Account type for linked Bancolombia account.

bancolombiaInstant.affiliate.documentNumber

string

Document number for linked Bancolombia account owner.

bancolombiaInstant.affiliate.documentType

string

Document type for linked Bancolombia account owner.

bancolombiaInstant.affiliate.name

string

Name of the linked Bancolombia account owner.

bancolombiaInstant.authUrl

string

Link for authorization. Only available while payment method status is "pending".

bankAccount

object

Show child attributes

bankAccount.accountNumber

string

Account number for payment method.

bankAccount.accountType

enum<string>

Account type for payment method.

Available options:

savings,

checking

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

createdAt

string

ISO string when the payment method was created.

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 this payment method.

id

string

Unique identifier for this payment method.

nequiInstant

object

Show child attributes

nequiInstant.phoneNumber

string

Account number for linked Nequi Account.

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

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

updatedAt

string

ISO string when the payment method was last updated.