Jump to Content

Home Guides API Reference

API Reference

Home Guides API Reference

Auth-Service

Intro
token
- Request tokenpost
- Introspect tokenpost
certificate
- Realm certget

Entities

Entity
Entity Contact
- Modify contact information of an identified Entity.put
- Delete contact information of an identified Entity.delete
Entity Alias
- updates reference information of an entity object.put
Entity Children
- Retrieving an identified Entity childrens.get
Entity Status
- Retrieving status of an identified Entity.get
- Set the status of an entity with entityId.put
Entity User
Entity User Status
- Referenced user status retrieval.get
- Update user status .put
Entity User Credentials
- Modification of user credentials.post
- Resetting the user credentials.post
Entity Metadata Type
Entity ProfileData Type

Wallets

Wallets
Payment methods
- Creates a wallet for a payment method.post
- Get paymentsMethodsget
Transactions
- View Wallet Specific Transactionget

Payment Methods

Payment method types
- Retrieves payment method types and their attributes.get
- Retrieves a single payment method type and its attributes.get
Payment methods
Payment methods links
- Creates a link between a payment method and a wallet.post
- It obtains wallet links for a specific payment method.get

Quotations

Quotations
- Creating a quotation.post
- Get a quotation.get

Transactions

Transactions
Transactions Types
Metadatakeys

Hosted Checkout

Introduction
Checkout Request
- Use the POST method to create a checkout page.post

Service Providers

Service Providers
Bills
- Gets the bills using a payment reference for a specific billing company.get
- Gets the bills using a payment reference for a specific billing company.get
Products
- Obtains the products offfered by a Seller company.get
- Obtains the products offfered by a Seller company.get

Issuing

Cards
TenantProduct
- Get all products of a tenantget
MCC
Tokenization

Issuing - Tokenization Events (Client Side)

/tokenizationEvent
- Tokenization events receptionput

Issuing - External Auth (client side)

External Authorization
- Request authorization to clientpost
- Inform authorization updateput

Giftcards API

Cards

KYC (Know Your Customer)

Documents
- Upload a documentpost
- Download A Documentget
Faces
- Upload a photo or video as a face proofpost
- Download A face proof Documentget
Checks
- Create a Checkpost
Reports
- Retrieve a Report Objectget
- List Reports related to a Check Objectget

SUBSCRIPTIONS API

Subscriptions
Payment
PaymentAttempt
- Get all payment attemptsget
- Retries a paymentpost

Remittance API

Remittances
Catalogs

Recipients API

Recipients
Payout Methods

VIRTUAL-ACCOUNTS API

VirtualAccounts

AccountValidator API

Account Validations
- Get the account validation data by id or correlation idget
- Initiate bank account ownership validationpost

Powered by

Partially update recipient information

patch https://example.com/entities/{entityId}/recipients/{recipientId}

Language

Click Try It! to start a request and see the response here!