{
  "id": "01HPR7A40E44S0WDR189YXA8GH",
  "reference": "<string>",
  "description": "<string>",
  "customerId": "<string>",
  "customerDetails": {
    "reference": "<string>",
    "name": "Pepito Perez",
    "documentType": "cc",
    "documentNumber": "1037551022",
    "email": "pepito@gmail.com",
    "phoneNumber": "3013111111"
  },
  "status": "pending",
  "statusMessage": "AUTHENTICATION_FAILED",
  "authUrl": "<string>",
  "redirectUrl": "<string>",
  "partialPayinsEnabled": true,
  "type": "bankAccount",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}
id
string

Unique identifier for this Payin Source.

reference
string

Reference sent in by merchant to identify Payin Source.

description
string

An extra metadata field that can be included for visibility.

customerId
string

Reference to customer who owns this Payin Source.

customerDetails
object
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
authUrl
string

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

redirectUrl
string

URL where the customer will be redirected after auth flow.

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.

type
enum<string>

Type of Payin Source created.

Available options:
bankAccount,
bancolombiaToken,
nequiToken
createdAt
string

ISO string indicating when the Payin Source was created.

updatedAt
string

ISO string indicating when the Payin Source was last updated.

Retrieve payin linkStatus