Create Payment

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

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

However, you can perform different types of payment authorization flows such as: Creating Payments with Card Vault, Creating Split Payments, Payment Creation with Late Split, Creating Pre-Authorized Payments e Creating Authorized Payments.

Body Params

amount

int32

required

Payment amount in cents without comma and full stop.

order_id

string

Your purchase identification number/Order number.

online_id

string

Your additional purchase identification number/Order number.

payment

object

required

Payment information, authorization model and flow to be executed.

customer

object

required

Customer-related information linked to 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

Headers

Authorization

string

required

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

Format
Bearer <access_token>

Responses

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-kosmos.ultrapayments.com.br/payments/api/sales \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Choose an example:

application/json

200200

400400

401401

422422