Skip to main content
POST
Active collection (pull)

Authorizations

Authorization
string
header
required

Session JWT (from register/login) or API key (pk_...). X-API-Key: <token> is accepted as an alternative header.

Headers

Idempotency-Key
string

Alternative to the idempotency_key body field.

Body

application/json
method
string
required

Collection method (e.g. c2p, debito_inmediato).

amount
string
required

Local amount as a positive decimal string.

idempotency_key
string
required

Required — a collect executes a real charge; retries with the same key never re-charge.

country
string
default:VE
currency
string
default:VES
description
string
our_reference
string
payer_document
string
payer_phone
string
payer_bank
string
payer_account
string
payer_name
string
payer_account_type
string
otp
string
otp_reference
string

Response

Collection result. paid: true means the deposit was credited.

payin_id
string
kind
string
country
string
currency
string
method
string
local_amount
string
status
string
fx_rate
string
usdt_gross
string
fee
string
usdt_credited
string
paid
boolean
provider_reference
string
status_code
string
status_message
string
failure
object

Present only when the payin is failed on active collections: where the rejection originated (provider = the payer's bank, core = pre-charge validation) plus the concrete code and message.

Last modified on July 18, 2026