Create a new payin - HelloPay API Documentation

curl --request POST \ --url https://api.example.com/payins \ --header 'Content-Type: application/json' \ --data ' { "amountInCents": 100000, "currency": "COP", "rail": "BRE_B", "reference": "INV-2024-001" } '

{ "id": "123e4567-e89b-12d3-a456-426614174000", "amount": 100000, "amountInCents": 10000000, "confirmedAmount": 100000, "confirmedAmountInCents": 10000000, "currency": "COP", "status": "PENDING", "settlementStatus": "PENDING_SETTLEMENT", "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", "paymentLinkId": "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

pse

object

PSE payment details (required when type is PSE)

Show child attributes

breb

object

BREB payment details (required when type is BRE_B)

Show child attributes

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

amountInCents

number

required

Payin amount in cents

Example:

10000000

confirmedAmount

object

required

Payin confirmed amount

Example:

100000

confirmedAmountInCents

object

required

Payin confirmed amount in cents

Example:

10000000

currency

string

required

Payin currency

Example:

"COP"

status

string

required

Payin status

Example:

"PENDING"

settlementStatus

object

required

Payin settlement status

Example:

"PENDING_SETTLEMENT"

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"

paymentLinkId

object

Payin payment link 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

callbackUrl

object

Payin callback URL

Example:

"https://example.com/callback"