POST
/
payments
curl --request POST \
  --url https://api.onepay.la/v1/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-idempotency: <x-idempotency>' \
  --data '{
  "amount": 123,
  "title": "<string>",
  "currency": "<string>",
  "phone": "<string>",
  "email": "<string>",
  "reference": "<string>",
  "tax": 123,
  "external_id": "<string>",
  "description": "<string>",
  "document_url": "<string>",
  "expiration_date": "<string>",
  "schedule_at": "<string>",
  "metadata": {},
  "splits": [
    {
      "customer_id": "<string>",
      "account_id": "<string>",
      "split_type": "<string>",
      "split_value": "<string>",
      "description": "<string>",
      "schedule_at": "<string>"
    }
  ],
  "allows": {
    "cards": true,
    "accounts": true,
    "card_extra": true,
    "realtime": true,
    "pse": true,
    "transfiya": true
  }
}'
{
   "source":"outbound",
   "currency":"COP",
   "amount":1400000,
   "title":"Prueba",
   "description":null,
   "phone":null,
   "expiration_at":"2025-03-20T22:36:24.000000Z",
   "document_link":"https://s3.us-east-2.amazonaws.com/onepay.production/customers/payments/requests/9e5ccd4a-d2f0-49dd-87fc-a0da752bd166.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=IQoJb3JpZ2luX2VjENb%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMiJGMEQCIF7OtPC77OI72zOeu6lclrqCt06jrgIdLQrgkjQXo0pZAiAbo0eIRCU3j2N6LZdeAYIwELWr8e7ig%2BP6JYNqm9t0KyqCAwggEAAaDDQxOTI0MzczMzM1NSIMF%2BJtmOc2LzqC1DCkKt8CWqtARyxOKA5Bjh3EQ8m2umlNUVmSwScBkco7aTZSCzjt4fdsy7IXAN8Xn89wyTY3R4e8ZUCeiRsPJtCKcwefUYA9wOuPC6TRQl%2FScHZsw53SeMlc8uH%2B8d5lWwXwhAT2D3QB3tyF3aBXekiBBQPBCATzL7bvSTETdCd4mCBnLH8uVVMIC6G8WChh3Y0G7q9AZa4JEezk88iBNl8243i2YOR%2B9U3YqX0hpgU%2FTDIAUIyNaPeViOs4p57G4ClmI%2BZF9Qp%2Bx47RmWYzDFkPl4Qpof5Nj8EeP8W6bbNzY4FplAGQDI2JajOMsUiBTnAzKiJ43pATWKTZXVOreTOj4Fm9rHPI4EfoAPknBTNW8w5lIgmIKBkbmfLcFsrGbBHocR0On8FSSYzPgWXOjv5dIxoR%2BCm6PDvojH41RRmbrkNOW6vL4AwSKrbl420xgNtESRXfdz7zDP9q33ac4q%2BzJ2ZFMIOgo74GOp8BcfOO4I82i115AVnQNohd9ZnLyZqAY1j8XFsCxaIdidF%2FtJF%2Be8rDugiu11tJadKG6TmWhCdzsicfAf4rCU%2FSWdi4YTPpcgrVlE%2BboPv4CvOXbYTzZX11diuJzzSQ0GBbLPj0oj%2FXgyLMdbQgkVJ18ugMsLHzCRMGFnCHetN%2BsFcZBJPo9PnDfzxWjuGm%2B%2BQpvjY17F2X91pb12eWUKUs&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAWDHG7WFVWCZPD4UG%2F20250305%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20250305T223627Z&X-Amz-SignedHeaders=host&X-Amz-Expires=300&X-Amz-Signature=17f1e472c71ee7142f78959de161e38f35ffc66961d2ae63b225cf2c14685fb3",
   "external_id":null,
   "allows":{
      "cards":true,
      "accounts":true,
      "card_extra":false,
      "realtime":false,
      "pse":true,
      "transfiya":true
   },
   "scheduled_date":null,
   "status":"pending",
   "metadata":[
      
   ],
   "source_id":null,
   "email":null,
   "reference":null,
   "redirect_url":null,
   "id":"9e5ccd4a-d2f0-49dd-87fc-a0da752bd166",
   "created_at":"2025-03-05T22:36:24.000000Z",
   "amount_label":"$1.400.000",
   "is_expired":false,
   "payment_link":"https://pagos.onepay.la/payment/9e5ccd4a-d2f0-49dd-87fc-a0da752bd166",
   "coupon_discount":0,
   "company":{
      "id":"9940779b-0d13-467a-b1a3-ac0a74b70e40",
      "name":"OnePay",
      "legal_name":"OnePay SAS",
      "phone":"+573242003451",
      "document_type":"NIT",
      "document_number":"901715267-7",
      "status":"active",
      "currency":"COP",
      "whatsapp_phone":"+573185371498",
      "industry":"agriculture"
   },
   "customer":null,
   "splits":[
      
   ],
   "coupon":null
}

Crea un nuevo pago en tu cuenta.

​
Headers

​
x-idempotency
string
required

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

​
Body

​
amount
number
required

Monto a cobrar cuando el cliente recibe el pago

​
title
string
required

Breve mensaje que se mostrará al usuario al realizar el pago

​
currency
string

Código de moneda ISO (COP, USD) por defecto COP

​
phone
string

Número de teléfono del cliente a enviar la solicitud de pago via whatsapp.

​
email
string

Campo opcional si quieres enviar una solicitud de pago via email

​
reference
string

Referencia de pago para que el usuario pueda interactuar con el portal de recaudo.

​
tax
number

Monto en la misma moneda con valor de impuestos, el valor predeterminado será del 19%

​
external_id
string

ID externo para relacionar el pago con un registro ya existente en tu sistema.

​
description
string

Descripción del pago

​
document_url
string

URL de un documento que se mostrará al usuario para que pueda realizar el pago.

​
expiration_date
date

Fecha de expiración del pago en formato YYYY-MM-DD HH:MM:SS

​
schedule_at
date

Fecha en la que el pago será enviado al usuario. YYYY-MM-DD.

​
metadata
object

Metadatos adicionales del pago en formato JSON

​
splits
array

Los pagos divididos permiten distribuir automáticamente un único pago entre múltiples destinatarios según reglas preestablecidas, optimizando la gestión de fondos sin necesidad de cálculos manuales o costos adicionales.

​
customer_id
string
required

ID del cliente que recibirá el pago.

​
account_id
string
required

ID de la cuenta registrada en onepay para recibir el pago.

​
split_type
string

Tipo de división: percentage o fixed

​
split_value
string
required

Valor del pago dividido si % o un monto

​
description
string
required

Descripción del pago para el cliente que recibirá el pago.

​
schedule_at
string

Fecha en la que el pago se le envía al cliente, si no existe una fecha se hará automáticamente. YYYY-MM-DD.

​
allows
object

Configuración de métodos de pago permitidos.

​
Response

​
id
string

Identificador único del pago

​
amount
number

Monto del pago en centavos

​
currency
string

Código de moneda ISO

​
status
string

Estado del pago:

  • pending - Pendiente
  • processing - Procesando
  • succeeded - Exitoso
  • failed - Fallido
​
customer_id
string

ID del cliente que realizó el pago

​
payment_method
string

Método de pago utilizado

​
description
string

Descripción del pago

​
metadata
object

Metadatos adicionales del pago

​
created_at
string

Fecha y hora de creación en formato ISO 8601

​
Ejemplo de petición

{
   "source":"outbound",
   "currency":"COP",
   "amount":1400000,
   "title":"Prueba",
   "description":null,
   "phone":null,
   "expiration_at":"2025-03-20T22:36:24.000000Z",
   "document_link":"https://s3.us-east-2.amazonaws.com/onepay.production/customers/payments/requests/9e5ccd4a-d2f0-49dd-87fc-a0da752bd166.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=IQoJb3JpZ2luX2VjENb%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMiJGMEQCIF7OtPC77OI72zOeu6lclrqCt06jrgIdLQrgkjQXo0pZAiAbo0eIRCU3j2N6LZdeAYIwELWr8e7ig%2BP6JYNqm9t0KyqCAwggEAAaDDQxOTI0MzczMzM1NSIMF%2BJtmOc2LzqC1DCkKt8CWqtARyxOKA5Bjh3EQ8m2umlNUVmSwScBkco7aTZSCzjt4fdsy7IXAN8Xn89wyTY3R4e8ZUCeiRsPJtCKcwefUYA9wOuPC6TRQl%2FScHZsw53SeMlc8uH%2B8d5lWwXwhAT2D3QB3tyF3aBXekiBBQPBCATzL7bvSTETdCd4mCBnLH8uVVMIC6G8WChh3Y0G7q9AZa4JEezk88iBNl8243i2YOR%2B9U3YqX0hpgU%2FTDIAUIyNaPeViOs4p57G4ClmI%2BZF9Qp%2Bx47RmWYzDFkPl4Qpof5Nj8EeP8W6bbNzY4FplAGQDI2JajOMsUiBTnAzKiJ43pATWKTZXVOreTOj4Fm9rHPI4EfoAPknBTNW8w5lIgmIKBkbmfLcFsrGbBHocR0On8FSSYzPgWXOjv5dIxoR%2BCm6PDvojH41RRmbrkNOW6vL4AwSKrbl420xgNtESRXfdz7zDP9q33ac4q%2BzJ2ZFMIOgo74GOp8BcfOO4I82i115AVnQNohd9ZnLyZqAY1j8XFsCxaIdidF%2FtJF%2Be8rDugiu11tJadKG6TmWhCdzsicfAf4rCU%2FSWdi4YTPpcgrVlE%2BboPv4CvOXbYTzZX11diuJzzSQ0GBbLPj0oj%2FXgyLMdbQgkVJ18ugMsLHzCRMGFnCHetN%2BsFcZBJPo9PnDfzxWjuGm%2B%2BQpvjY17F2X91pb12eWUKUs&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAWDHG7WFVWCZPD4UG%2F20250305%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20250305T223627Z&X-Amz-SignedHeaders=host&X-Amz-Expires=300&X-Amz-Signature=17f1e472c71ee7142f78959de161e38f35ffc66961d2ae63b225cf2c14685fb3",
   "external_id":null,
   "allows":{
      "cards":true,
      "accounts":true,
      "card_extra":false,
      "realtime":false,
      "pse":true,
      "transfiya":true
   },
   "scheduled_date":null,
   "status":"pending",
   "metadata":[
      
   ],
   "source_id":null,
   "email":null,
   "reference":null,
   "redirect_url":null,
   "id":"9e5ccd4a-d2f0-49dd-87fc-a0da752bd166",
   "created_at":"2025-03-05T22:36:24.000000Z",
   "amount_label":"$1.400.000",
   "is_expired":false,
   "payment_link":"https://pagos.onepay.la/payment/9e5ccd4a-d2f0-49dd-87fc-a0da752bd166",
   "coupon_discount":0,
   "company":{
      "id":"9940779b-0d13-467a-b1a3-ac0a74b70e40",
      "name":"OnePay",
      "legal_name":"OnePay SAS",
      "phone":"+573242003451",
      "document_type":"NIT",
      "document_number":"901715267-7",
      "status":"active",
      "currency":"COP",
      "whatsapp_phone":"+573185371498",
      "industry":"agriculture"
   },
   "customer":null,
   "splits":[
      
   ],
   "coupon":null
}

Was this page helpful?