Create a new payin

POST

payins

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "amount": 100000,
  "currency": "COP",
  "status": "PENDING",
  "rail": "BRE_B",
  "reference": "INV-2024-001",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "inlineCustomer": "John Doe",
  "errorCode": null,
  "resultAt": "2024-01-01T00:00:00.000Z",
  "chargebackAt": "2024-01-01T00:00:00.000Z",
  "sourceData": {
    "keyString": "breb-key-string"
  },
  "callbackUrl": "https://example.com/callback"
}

Body

application/json

amountInCents

number

required

Payment amount in cents

Required range: x >= 1

Example:

100000

currency

string

required

Payment currency

Example:

"COP"

rail

string

required

Payment rail type

Example:

"BRE_B"

reference

string

required

Unique reference for the payment

Example:

"INV-2024-001"

inlineCustomer

object

Customer data

Show child attributes

inlineCustomer.name

string

required

Customer full name

Example:

"John Doe"

inlineCustomer.idType

enum<string>

required

Type of identification document

Available options:

CO_CC,

MXN_RFC,

PASSPORT

Example:

"CO_CC"

inlineCustomer.idNumber

string

required

Identification document number

Example:

"1234567890"

inlineCustomer.phone

string

required

Customer phone number

Example:

"+573001234567"

inlineCustomer.email

string

required

Customer email address

Example:

"john.doe@example.com"

breb

object

BREB payment details (required when type is BRE_B)

Show child attributes

breb.keyString

string

required

BREB payment key string

Example:

"breb-key-string"

callbackUrl

string

Callback URL

Example:

"https://example.com/callback"

Response

Payin successfully created

string

required

Payin ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

amount

number

required

Payin amount

Example:

100000

currency

string

required

Payin currency

Example:

"COP"

status

string

required

Payin status

Example:

"PENDING"

rail

string

required

Payin rail

Example:

"BRE_B"

reference

string

required

Payin reference

Example:

"INV-2024-001"

createdAt

string<date-time>

required

Payin created at

Example:

"2024-01-01T00:00:00.000Z"

updatedAt

string<date-time>

required

Payin updated at

Example:

"2024-01-01T00:00:00.000Z"

organizationId

string

required

Payin organization ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

inlineCustomer

object

Payin inline customer

Example:

"John Doe"

errorCode

object

Payin error code

Example:

null

resultAt

object

Payin result at

Example:

"2024-01-01T00:00:00.000Z"

chargebackAt

object

Payin chargeback at

Example:

"2024-01-01T00:00:00.000Z"

sourceData

object

Payin pse response

Show child attributes

sourceData.keyString

string

required

BREB payment key string

Example:

"breb-key-string"

callbackUrl

object

Payin callback URL

Example:

"https://example.com/callback"

Get a specific payinRetrieves a single payin by ID.

⌘I

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "amount": 100000,
  "currency": "COP",
  "status": "PENDING",
  "rail": "BRE_B",
  "reference": "INV-2024-001",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "inlineCustomer": "John Doe",
  "errorCode": null,
  "resultAt": "2024-01-01T00:00:00.000Z",
  "chargebackAt": "2024-01-01T00:00:00.000Z",
  "sourceData": {
    "keyString": "breb-key-string"
  },
  "callbackUrl": "https://example.com/callback"
}

Getting Started

Guides

API reference

Body

Response