Jump to Content

v1.0

API Reference

v1.0API Reference

LANGUAGES

Portuguese
Español

INTEGRATION

Introduction

AUTHENTICATION

Introduction to authentication

PAYMENTS

Introduction
Create Paymentpost
Create Payment Splitpost
Capture Pre-Authorized Paymentpost
Cancel Paymentpost
Consult payment informationget
Enable Late Splitpost
Create Card Vaultpost
Disable Card Vaultput
List Card Vaultget
Retrieve transaction feesget
List Paymentsget
Test Cards
Return Codes
Use Cases

PIX

Introduction
Create Pix Paymentpost
Query Pix Paymentget
Pix Payment Refundpost

PAYMENT LINK

Introduction
Create Payment Linkpost
Upload the logo for the payment linkpost

RECURRING

Introduction
Create Recurrencepost
Create Recurrence Linkpost

ESTABLISHMENTS

Introduction
Retrieve Establishmentget
Create Establishmentpost
List CNAEsget
List Banksget
Use Cases

SETTLEMENTS

Extratoget
Analytical Extractget
Future Statementget

ADVANCEMENTS

Introduction
Update Automatic Anticipationput
List available advancesget
Request Advancepost

WEBHOOKS

Register Webhookpost
Webhook resubmissionpost
Resending of Establishment Webhookpost
Webhook Example

OTHERS

Homologação Process

Powered by

SETTLEMENTS

Analytical Extract

get

https://api-kosmos.ultrapayments.com.br/app/api/extracts/analytics

Language