Crear División de Pago

post https://api-kosmos.ultrapayments.com.br/payments/api/sales/splits

Este es el endpoint destinado a la solicitud de creación de preautorización o autorización de un split de arreglo de pago.

Para crear un pago con split, es necesario hacer un POST al recurso Sales informando en el payload el valor de la transacción en amount, y la información del pago dentro de los objetos payment y customer según el ejemplo. También se requiere un array de splits con al menos dos objetos representando a los integrantes del split. El primer objeto del array DEBE tener el atributo merchantType definido como PRIMARY, y su atributo recipientToken DEBE representar el accessToken vinculado al comerciante donde ocurrió la transacción. Los demás objetos tendrán el atributo merchantType como SECONDARY y su recipientToken referente al accessToken de otro comerciante que desea participar en el split.

OBSERVACIONES:

El array de splits solo acepta un único integrante como PRIMARY.
El integrante PRIMARY NO puede recibir menos del 1% de la transacción.
La suma de todos los integrantes del split NO puede ser diferente del valor neto de la transacción.

Body Params

amount

int32

required

Valor del pago en centavos sin comas ni puntos.

orderId

string

Su número de identificación de compra/Número de pedido.

online_id

string

Su número de identificación adicional de compra/Número de pedido.

payment

object

required

Información del pago, modelo de autorización y flujo a ejecutar.

customer

object

required

Información relacionada con el cliente vinculado al pago.

metadata

array of objects

El parámetro metadata permite a los usuarios adjuntar información adicional a una transacción. Esto puede incluir cualquier par de clave-valor que proporcione contexto o detalles adicionales sobre la transacción. El metadata no es utilizado por la API para procesar la transacción, pero puede ser útil para el registro del usuario o para la integración con otros sistemas.

metadata

splits

array of objects

Información sobre la división de pagos. Indique si se trata de una operación de división de pagos.

splits

Headers

Authorization

string

required

Clave de integración única generada por Autenticación de Pago (PayAuth) para el establecimiento.

Formato
Bearer <access_token>

Responses

Language


xxxxxxxxxx
11
1
curl --request POST \
2
     --url https://api-kosmos.ultrapayments.com.br/payments/api/sales/splits \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "payment": {
8
    "type": "credit"
9
  }
10
}
11
'

Choose an example:

application/json

200200

400400

401401

422422