payments-api

Create Public Charge

post/api/v1/payments/charges

Request

  • Base URL: https://www.elocuenti.com
  • URL: https://www.elocuenti.com/api/v1/payments/charges
  • Auth: HTTP bearer

Headers

Idempotency-Keystring nullable

Required. Retrying with the same key returns the same charge.

Request body

amount_in_centsinteger nullable

Amount the payer pays, in cents (COP 1.000 = 100000). Omit it to send price_amount.

price_currency'USD' nullable

Prices in dollars (turn it on in Ajustes de cobros): the payer pays in COP at the day's official rate (TRM) + 1.5 %, held 24 h. Send it with price_amount instead of amount_in_cents.

price_amountinteger nullable

Your price in US cents (US$70 = 7000), with price_currency.

currency'COP'
descriptionstring

What the payer sees on the checkout.

customer_countrystring nullable

ISO 3166-1 alpha-2, e.g. CO.

method_hint'any' | 'nequi' | 'card' | 'pse' | 'qr'

any opens the checkout; the others start that method directly.

allowed_methodsstring[] nullable

Methods the checkout offers; omit it for every method the account has enabled.

external_referencestring nullable

Your id for this charge, unique per account and environment (reuse: 409).

return_urlstring nullable

https URL the payer's browser returns to after paying.

notification_urlstring nullable

https URL that receives the signed status notification (see webhooks).

expires_in_minutesinteger

Minutes until it expires.

metadataobject nullable

Stored as-is, never shown.

Response

Successful Response

request_idstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.