Main Navigation Home Guide

Appearance

Sidebar Navigation

Introduction

Getting Started

Progress

Handling Failures

Transactions

Initialize Transaction

Verify Transaction ⚠︎

List Transactions ⚠︎

Fetch Transaction ⚠︎

Charge Authorization ⚠︎

View Transaction Timeline ⚠︎

Transaction Totals ⚠︎

Export Transactions ⚠︎

Partial Debit ⚠︎

Transaction Splits

Create Split ⚠︎

List/Search Splits ⚠︎

Fetch Split ⚠︎

Update Split ⚠︎

Add/Update Split ⚠︎

Subaccount ⚠︎

Remove Subaccount from Split ⚠︎

Terminal

Send Event ⚠︎

Fetch Event Status ⚠︎

Fetch Terminal Status ⚠︎

List Terminals ⚠︎

Fetch Terminal ⚠︎

Update Terminal ⚠︎

Commission Terminal ⚠︎

Decommission Terminal ⚠︎

Virtual Terminal

Create Virtual Terminal ⚠︎

List Virtual Terminals ⚠︎

Fetch Virtual Terminal ⚠︎

Update Virtual Terminal ⚠︎

Deactivate Virtual Terminal ⚠︎

Assign Virtual Terminal Destination ⚠︎

Unassign Virtual Terminal Destination ⚠︎

Add Split Code to Virtual Terminal ⚠︎

Remove Split Code from Virtual Terminal ⚠︎

Customers

Create Customer ⚠︎

List Customers ⚠︎

Fetch Customer ⚠︎

Update Customer ⚠︎

Validate Customer ⚠︎

Whitelist/Blacklist Customer ⚠︎

Deactivate Authorization ⚠︎

Dedicated Virtual Accounts

Create Dedicated Virtual Account ⚠︎

Assign Dedicated Virtual Account ⚠︎

List Dedicated Accounts ⚠︎

Fetch Dedicated Account ⚠︎

Requery Dedicated Account ⚠︎

Deactivate Dedicated Account ⚠︎

Split Dedicated Account Transaction ⚠︎

Remove Split from Dedicated Account ⚠︎

Fetch Bank Providers ⚠︎

Apple Pay

Register Domain ⚠︎

List Domains ⚠︎

Unregister Domain ⚠︎

Subaccounts

Create Subaccount ⚠︎

List Subaccounts ⚠︎

Fetch Subaccount ⚠︎

Update Subaccount ⚠︎

Plans

Create Plan ⚠︎

List Plans ⚠︎

Fetch Plan ⚠︎

Update Plan ⚠︎

Subscriptions

Create Subscription ⚠︎

List Subscriptions ⚠︎

Fetch Subscription ⚠︎

Enable Subscription ⚠︎

Disable Subscription ⚠︎

Generate Update Subscription Link ⚠︎

Send Update Subscription Link ⚠︎

Products

Create Product ⚠︎

List Products ⚠︎

Fetch Product ⚠︎

Update Product ⚠︎

Payment Pages

Create Page ⚠︎

List Pages ⚠︎

Fetch Page ⚠︎

Update Page ⚠︎

Check Slug Availability ⚠︎

Add Products ⚠︎

Payment Requests

Create Payment Request ⚠︎

List Payment Requests ⚠︎

Fetch Payment Request ⚠︎

Verify Payment Request ⚠︎

Send Notification ⚠︎

Payment Request Total ⚠︎

Finalize Payment Request ⚠︎

Update Payment Request ⚠︎

Archive Payment Request ⚠︎

Settlements

List Settlements ⚠︎

List Settlement Transactions ⚠︎

Transfer Recipients

Create Transfer Recipient ⚠︎

Bulk Create Transfer Recipient ⚠︎

List Transfer Recipients ⚠︎

Fetch Transfer Recipient ⚠︎

Update Transfer Recipient ⚠︎

Delete Transfer Recipient ⚠︎

Transfers

Initiate Transfer ⚠︎

Finalize Transfer ⚠︎

Initiate Bulk Transfer ⚠︎

List Transfers ⚠︎

Fetch Transfer ⚠︎

Verify Transfer ⚠︎

Transfers Control

Check Balance ⚠︎

Fetch Balance Ledger ⚠︎

Resend Transfers OTP ⚠︎

Disable Transfers OTP ⚠︎

Finalize Disable OTP ⚠︎

Enable Transfers OTP ⚠︎

Bulk Charges

Initiate Bulk Charge ⚠︎

List Bulk Charge Batches ⚠︎

Fetch Bulk Charge Batch ⚠︎

Fetch Charges in a Batch ⚠︎

Pause Bulk Charge Batch ⚠︎

Resume Bulk Charge Batch ⚠︎

Integration

Fetch Payment Session Timeout ⚠︎

Update Payment Session Timeout ⚠︎

Charge

Create Charge ⚠︎

Submit PIN ⚠︎

Submit OTP ⚠︎

Submit Phone ⚠︎

Submit Birthday ⚠︎

Submit Address ⚠︎

Check Pending Charge ⚠︎

Disputes

List Disputes ⚠︎

Fetch Dispute ⚠︎

List Transaction Disputes ⚠︎

Update Dispute ⚠︎

Add Evidence ⚠︎

Get Upload URL ⚠︎

Resolve a Dispute ⚠︎

Export Disputes ⚠︎

Refunds

Create Refund ⚠︎

List Refunds ⚠︎

Fetch Refund ⚠︎

Verification

Resolve Account Number ⚠︎

Validate Account ⚠︎

Resolve Card BIN ⚠︎

Miscellaneous

List Banks ⚠︎

List or Search Countries ⚠︎

List States (AVS) ⚠︎

On this page

Getting Started

This part of the documentation is still work in progress. Check later or submit a PR

Last updated:

Pager

Previous pageSubaccount ⚠︎

Next pageSend Event ⚠︎

Released under the MIT License.

Getting Started ​

Getting Started