Payin Source schema

authUrl

string

URL where the customer should be redirected to complete the account authentication and debit authorization.

createdAt

string

ISO string indicating when the Payin Source was created.

customerDetails

object

customerId

string

Reference to customer who owns this Payin Source.

description

string

An extra metadata field that can be included for visibility.

id

string

Unique identifier for this Payin Source.

partialPayinsEnabled

boolean

Only available for Bancolombia. Partial debit will be made if the account does not have sufficient funds to debit the total amount. By default, no partial debits will be made.

redirectUrl

string

URL where the customer will be redirected after auth flow.

reference

string

Reference sent in by merchant to identify Payin Source.

status

enum<string>

Status of the Payin Source.

Available options:

pending,

processing,

active,

cancelled

statusMessage

enum<string>

Additional detail on the status. Only present when status is "cancelled".

Available options:

AUTHENTICATION_FAILED,

CUSTOMER_CANCELLATION,

DECLINED_BY_BANK,

EXPIRED,

INVALID_ACCOUNT,

NOT_ENOUGH_FUNDS,

ERROR

type

enum<string>

Type of Payin Source created.

Available options:

bankAccount,

bancolombiaToken,

nequiToken

updatedAt

string

ISO string indicating when the Payin Source was last updated.

Introduction

API Documentation

Webhooks

Payin Source schema