POST
utilities
/
links
curl --request POST \
  --url https://api.onepay.la/v1/utilities/links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-idempotency: <x-idempotency>' \
  --data '{
  "reference": "<string>",
  "amount": 123,
  "customer": {
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "document_type": "<string>",
    "document_number": "<string>"
  }
}'
{
  "id": "d7e214b7-75c1-427f-a810-4e4a4fb01cd4",
  "redirect_url": "https://pagos.onepay.la/payment/d7e214b7-75c1-427f-a810-4e4a4fb01cd4"
}

​
Headers

​
x-idempotency
string
required

Token único para garantizar la idempotencia de la petición

​
Body

​
reference
string
required

Referencia de pago para el convenio. de ejemplo puedes usar 111100005555

​
amount
number

Monto de pago para el convenio, es opcional si no se envia se consultaran los servicios disponibles para obtener el monto.

​
customer
object

Objeto con los datos del cliente.

​
first_name
string

Nombre del cliente.

​
last_name
string

Apellido del cliente.

​
email
string

Email del cliente [opcional].

​
phone
string

Telefono del cliente en formato E.164.

​
document_type
string

Tipo de documento del cliente [CC, CE, TI, NIT, PPT]

​
document_number
string

Número de documento del cliente.

{
  "id": "d7e214b7-75c1-427f-a810-4e4a4fb01cd4",
  "redirect_url": "https://pagos.onepay.la/payment/d7e214b7-75c1-427f-a810-4e4a4fb01cd4"
}

Was this page helpful?