Jump to Content
Home
Guides
API Reference
Contact Us
API Reference
Contact Us
Home
Guides
API Reference
Create a new remittance recipient
Search
JUMP TO
Auth-Service
Intro
token
Request token
post
Introspect token
post
certificate
Realm cert
get
Entities
Entity
Retrieving Entities.
get
Creating a new Entity.
post
Retrieving an identified Entity.
get
Modify an identified Entity.
put
Entity deletion.
delete
Updating properties of an Entity.
patch
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
Users associated with an Entity.
get
New user associated with an Entity.
post
Referenced user retrieval.
get
Deletion of a referenced user.
delete
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
Get all metadata type associated with an Entity.
get
New metadata type associated with an Entity.
post
Retrieve the metadata type.
get
Modify an identified Metadata.
put
Metadata deletion.
delete
Entity ProfileData Type
Get all ProfileData type associated with an Entity.
get
New ProfileData type associated with an Entity.
post
Retrieve the ProfileData type.
get
Modify an identified ProfileData.
put
ProfileData deletion.
delete
Wallets
Wallets
Creating a wallet.
post
View Wallet Information
get
Update a Wallet
patch
View Wallet Entity
get
View Wallet Balance
get
Creates a list of alias for a wallet.
put
Payment methods
Creates a wallet for a payment method.
post
Get paymentsMethods
get
Transactions
View Wallet Specific Transaction
get
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
Returns the balance of a payment method.
get
Deletes a payment method.
delete
Creates a list of alias for a payment method.
put
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
Creating a transaction.
post
View a transaction
get
Update a Transaction:
patch
Creating a reversal
post
Creating an annulment
post
Creating a dispute
post
Creating a refund
post
Get all enabled currencies
get
Transactions Types
Get all Transaction Types
get
Get all Transaction Subtypes for a given type
get
Add Transaction Subtypes for a given Type
post
Metadatakeys
Get all Transaction Metadata Keys
get
Add a Transaction Metadata Key
put
Delete a Transaction Metadata Key
delete
Hosted Checkout
Introduction
Checkout Request
Use the POST method to create a checkout page.
post
Service Providers
Service Providers
View Pay Bill configuration
get
View Products configuration
get
View Service Providers Companies
get
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
Create a nominated card
post
returns a list of cards matching with the filtering criteria.
get
Retrieve a card object identified by cardReference
get
Patch a card data
patch
Activcate the card identified by cardReference
put
Assign Card PIN
put
Reset Card PIN
post
Set a new CVV to a card
put
Assign a physical card identified by cardReference
put
Deactivate the card identified by cardReference
put
Block a card (it is reversible)
put
Unblock a Card
put
Set profile to a card
put
Print a virtual card if the product is digitalFirst
put
Enable a printed digitalFirst card for POS
put
TenantProduct
Get all products of a tenant
get
MCC
Get all MCC categories
get
Retrieve a MCC category info
get
Retrieve a MCC category name
get
Tokenization
List tokens
get
Activate a token of a card
post
Stop a token of a card
post
Unstop a token of a card
post
Delete a token of a card
post
Issuing - Tokenization Events (Client Side)
/tokenizationEvent
Tokenization events reception
put
Issuing - External Auth (client side)
External Authorization
Request authorization to client
post
Inform authorization update
put
Giftcards API
Cards
Get Giftcard Info filtered list
get
Post Giftcard
post
Get Giftcard Info by ID
get
Patch Giftcard
patch
Put Giftcard for card activation
put
Put Giftcard for card deactivation
put
KYC (Know Your Customer)
Documents
Upload a document
post
Download A Document
get
Faces
Upload a photo or video as a face proof
post
Download A face proof Document
get
Checks
Create a Check
post
Reports
Retrieve a Report Object
get
List Reports related to a Check Object
get
SUBSCRIPTIONS API
Subscriptions
Get Subscription Info filtered list
get
Post Subscription
post
Get Subscription Info by ID
get
Payment
Get payments by filters
get
Get payment data
get
Manually creates or modifies a payment
put
PaymentAttempt
Get all payment attempts
get
Retries a payment
post
Remittance API
Remittances
Execute a quote preview
post
Create a quote
post
Create a remittance
post
Get remittances
get
Get a remittance
get
Cancels a remittance
post
Refund a remittance
put
Catalogs
Get Payment Agents
get
Get Payment Agent Regions
get
Get Payment Agent Branches
get
Get list of available countries
get
Get payout methods
get
Get states for a specific country
get
Recipients API
Recipients
Create a new remittance recipient
post
Get all recipients
get
Get recipient by ID
get
Delete recipient by ID
delete
Partially update recipient information
patch
Payout Methods
Add a payout method for a recipient
post
Get all payout methods for a recipient
get
Get a payout method by ID for a recipient
get
Get a payout method by ID for a recipient
delete
Partially update payout method information using JSON Patch
patch
VIRTUAL-ACCOUNTS API
VirtualAccounts
Get VirtualAccount Info filtered list
get
Post VirtualAccount
post
Get VirtualAccount Info by RequestReference
get
Delete VirtualAccount
delete
Patch VirtualAccount
patch
AccountValidator API
Account Validations
Get the account validation data by id or correlation id
get
Initiate bank account ownership validation
post
Powered by
Create a new remittance recipient
post
https://example.com/entities/
{entityId}
/recipients
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!
