Jump to Content
Documentation
APIs
v1.3
Log In
APIs
Log In
Moon (Dark Mode)
Sun (Light Mode)
Version 1.3 (BaaS)
Documentation
APIs
/api/v1/ping
Search
All
Pages
Start typing to search…
JUMP TO
Customer
Customer Creation
Create Customer by Country
post
Get Customer by Country
get
Get Customer by Email
get
ONboarding
KYC (Individuals)
List KYC Requirements
get
Get KYC Info
get
Update KYC Info
put
Get KYC Status
get
Get Customer KYC Submission
get
Get KYC Verification Url
get
Get KYC iFrame Url
get
Submit KYC
post
Add KYC Files
post
Add KYC Info
post
KYB (Business)
Update KYB Info
put
Get KYB Status
get
Add KYB Files
post
Add KYB Info
post
Submit KYB
put
List KYB Requirements
get
Quotes
Create Quote
post
Get Quote
get
ON-RAMP
List Onramp Requirements
get
Create Onramp Transaction
post
Get Onramp Transaction
get
List Onramp Transactions
get
OFF-RAMP
Third Party Payment
Generate payment
post
Register FIAT account
Create Payment Method
post
List Payment Method Requirements
get
List Customer Payment Methods
get
Delete Payment Method
del
Create OffRamp Transaction
post
Get Offramp Transaction
get
List OffRamp Transactions
get
Liquidation Addresses
Liquidation Addresses
Create a liquidation address
post
Get all liquidation addresses for a customer
get
Get a specific liquidation address
get
Update a liquidation address
put
Get default liquidation address
get
Get address history for a customer
get
Get all liquidation address activity
get
Banking as a Service
Virtual Account
Get Virtual Account by Customer
get
List Transactions by Account
get
Payment Processing
QR Interoperable
Get QR code data
post
Execute a payment using QR
post
Get payment status by transaction ID
get
Webhook for incoming payment notification
post
Operations
Setup
Webhook
post
List Configs
get
Customer Support
Support
Create Support Ticket
post
List Support Tickets by Customer
get
Get Support Ticket
get
Alfred API
App
/api/v1/ping
get
/api/v1/ping
get
Api Keys
/api/v1/third-party-service/api-keys/list/{customerId}
get
/api/v1/third-party-service/api-keys/verify
post
/api/v1/third-party-service/api-keys/create
post
/api/v1/third-party-service/api-keys/delete
put
/api/v1/third-party-service/api-keys/list/{customerId}
get
/api/v1/third-party-service/api-keys/verify
post
/api/v1/third-party-service/api-keys/create
post
/api/v1/third-party-service/api-keys/delete
put
Authentication
/api/v1/auth/token
post
Customer
/api/v1/third-party-service/penny/customers/create
post
Submit KYB
post
Endpoint to submit required non-file upload KYC information to liquidity partner
post
Submit KYB Files
post
Endpoint to support file uploads to liquidity partner
post
Endpoint to update required non-file upload KYC information to liquidity partner
put
update customer KYB
put
status KYB
get
status KYB
get
Update status kyc
post
get url kyc session
get
get verification url
get
Get customer id by email adn country
get
Get submission by customer
get
Get customers by email
get
Limit customers
get
Get info detail customer
get
/api/v1/third-party-service/penny/customers
post
/api/v1/third-party-service/penny/customers/status/{email}
get
/api/v1/third-party-service/penny/customers/create
post
Submit KYB
post
Endpoint to submit required non-file upload KYC information to liquidity partner
post
Submit KYB Files
post
Endpoint to support file uploads to liquidity partner
post
Endpoint to update required non-file upload KYC information to liquidity partner
put
update customer KYB
put
status KYB
get
status KYB
get
Update status kyc
post
get url kyc session
get
get verification url
get
Get customer id by email adn country
get
Get submission by customer
get
Get customers by email
get
Limit customers
get
Get info detail customer
get
/api/v1/third-party-service/penny/customers
post
/api/v1/third-party-service/penny/customers/status/{email}
get
Quotes
Get Quotes
get
Create Quotes
post
Get Quotes
get
Create Quotes
post
Onramp
List individual on ramp transaction
get
onramp pay-in
post
List Onramp Transactions
get
get deposit address from onramp
get
list onramp by customer id
get
List individual on ramp transaction
get
onramp pay-in
post
List Onramp Transactions
get
get deposit address from onramp
get
list onramp by customer id
get
Offramp
submit offramp
post
List Onramp Transactions
get
List individual offramp transaction
get
list offramp by customer id
get
submit offramp
post
List Onramp Transactions
get
List individual offramp transaction
get
list offramp by customer id
get
FiatAccount
Returns a list of fields that collects and passes to the liquidity partner to submit a beneficiary fiat account.
get
Endpoint to add beneficiary fiat instructions for a customer.
post
Endpoint to list beneficiary fiat accounts added by a customer.
get
Endpoint to delete beneficiary fiat accounts by a customer.
del
Get fiat account by id
get
Returns a list of fields that collects and passes to the liquidity partner to submit a beneficiary fiat account.
get
Endpoint to add beneficiary fiat instructions for a customer.
post
Endpoint to list beneficiary fiat accounts added by a customer.
get
Endpoint to delete beneficiary fiat accounts by a customer.
del
Get fiat account by id
get
Business
Generate api key business
post
Generate secret key business
post
Generate secret key business
post
Generate api key business
post
Generate secret key business
post
Generate secret key business
post
SupportTicket
Endpoint create support ticket
post
Endpoint create support ticket
get
Endpoint get By support ticket
get
Endpoint create support ticket
post
Endpoint create support ticket
get
Endpoint get By support ticket
get
Webhooks
Webhook to update info by events
post
Webhook to update info by events
post
Configurations
Endpoint to List All Configs.
get
Endpoint to List All Configs.
get
Aiprise
Webhook aiprise to create individual customer
post
Webhook aiprise to update KYC events
post
Webhook aiprise to update KYB events
post
Webhook aiprise to create individual customer
post
Webhook aiprise to update KYC events
post
Webhook aiprise to update KYB events
post
KYB
KYB - Get Business Verification Url
get
Webhook to update KYB
post
KYB - Get Business Verification Url
get
Webhook to update KYB
post
ThirdPartyService
List KYC Requirements
get
List KYC Requirements
get
Recipients
List Recipients
get
Find Recipient
get
Get Payment Recipient
get
Get Payment Recipient Crypto
get
Get Recipient Rules
get
Create Recipient
post
Update Recipient
put
Create Recipient
del
List Recipients
get
Find Recipient
get
Get Payment Recipient
get
Get Payment Recipient Crypto
get
Get Recipient Rules
get
Create Recipient
post
Update Recipient
put
Create Recipient
del
Transactions
List Transations by Customer
get
Get Transation
get
Create Send Global Transation
post
Create Payment Global Transation
post
Create Onramp Global Transation
post
Create Onramp Global Transation
post
Cancel Payment Global Transation
put
List Transations by Customer
get
Get Transation
get
Create Send Global Transation
post
Create Payment Global Transation
post
Create Onramp Global Transation
post
Create Onramp Global Transation
post
Cancel Payment Global Transation
put
VirtualAccount
Get Virtual Accounts by Customer
get
Get Virtual Account Details
get
Create Virtual Account
post
Update Visibility Virtual Account
put
Get Virtual Accounts by Customer
get
Get Virtual Account Details
get
Create Virtual Account
post
Update Visibility Virtual Account
put
Authentication
/api/v1/auth/token
post
Powered by
/api/v1/ping
get
https://example.com/api/v1/ping
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!
