API Reference

This is the endpoint for requesting the creation of a pre-authorization or authorization for a payment arrangement split.

To create a payment with a split, you need to make a POST request to the Sales resource, specifying the transaction amount in the amount field and including payment and customer information within the payment and customer objects as shown in the example. You also need an array of splits with at least two objects representing the participants in the split. The first object in the array MUST have the merchantType attribute set to PRIMARY, and its recipientToken MUST represent the accessToken linked to the merchant where the transaction occurred. The other objects will have the merchantType attribute set to SECONDARY, with their recipientToken representing the accessToken of another merchant who wishes to participate in the split.

NOTES:

  • The splits array only accepts one PRIMARY participant.
  • The PRIMARY participant cannot receive less than 1% of the transaction.
  • The total of all split participants must equal the net transaction amount.
Body Params
int32
required

Payment amount in cents without comma and period.

string

Your additional purchase identification number/Order number.

string

Your purchase identification number/Order number.

payment
object
required

Payment information, authorization model and flow to be executed.

customer
object
required

Information related to the customer linked to the payment.

metadata
array of objects

The metadata parameter allows users to attach additional information to a transaction. This can include any key-value pairs that provide extra context or details about the transaction. The metadata is not used by the API to process the transaction but can be useful for the user's record-keeping or for integration with other systems.

metadata
splits
array of objects

Information about Payment Split. Notify if it's a operation of Payment Split.

splits
Headers
string
required

Unique integration key generated by Payment Authentication (PayAuth) for the establishment.

Format
Bearer <access_token>

Responses

Language
Choose an example:
application/json