/

Docs from a schema DocsSign in

Docs
History
Schema
Generate

Filter operations

Location6

get/v1/locationsList locations
post/v1/locationsCreate location
get/v1/locations/{location}Get location
put/v1/locations/{location}Update location
delete/v1/locations/{location}Delete location
patch/v1/locations/{location}Toggle location active status

Payouts4

Virtual Accounts3

get/v1/account-statusGet Account Status
get/v1/staffsGet All Staffs
get/v1/staffs/{staff_id}Get Staff Detail
post/v1/refundRefund
get/v1/refund/{refund_id}Get Refund Details
get/v1/subscription-planGet All Subscription Plan
post/v1/subscription-planCreate a Subscription Plan
get/v1/subscription-plan/{plan_id}Get Subscription Plan Details
put/v1/subscription-plan/{plan_id}Update Subscription Plan
delete/v1/subscription-plan/{plan_id}Delete Subscription Plan
get/v1/recurring-billingGet All Recurring Billing
post/v1/recurring-billingCreate Recurring Billing
get/v1/recurring-billing/{recurring_billing_id}Get saved card details
put/v1/recurring-billing/{recurring_billing_id}Update Recurring Billing
delete/v1/recurring-billing/{recurring_billing_id}Delete Recurring Billing
post/v1/charge/recurring-billing/{recurring_billing_id}Charge the saved card
get/v1/payment-requestsGet Payment Requests
post/v1/payment-requestsCreate Payment Request
get/v1/payment-requests/{request_id}Get Payment Request Status
put/v1/payment-requests/{request_id}Update Payment Request
delete/v1/payment-requests/{request_id}Delete Payment Request
get/v1/charges/exportExport Charges
get/v1/chargesGet All Charges
get/v1/charges/{charge_id}Get Charge Details
post/v1/charges/{charge_id}/receipt/printPrint Receipt
get/v1/ordersGet Orders
post/v1/ordersCreate Order
get/v1/orders/{order_id}Get Order Details
delete/v1/orders/{order_id}Delete Order
patch/v1/orders/{order_id}Update the order
put/v1/invoices/{invoice_id}Update the invoice
delete/v1/invoices/{invoice_id}Delete Invoice
get/v1/invoicesGet all invoice
post/v1/invoicesCreate the invoice
get/v1/balancesGet Balances
get/v1/balances/{balance_provider}/transactionsGet Balance Transactions
post/v1/balances/{balance_provider}/transactions/exportExport Balance Breakdown
post/v1/beneficiaries/schemaGet the API schema
get/v1/beneficiariesGet list of beneficiaries
post/v1/beneficiariesCreate a new beneficiary
get/v1/beneficiaries/{beneficiary_id}Get a beneficiary by ID
delete/v1/beneficiaries/{beneficiary_id}Delete existing beneficiary
patch/v1/beneficiaries/{beneficiary_id}Update existing beneficiary
get/v1/remittersGet list of remitters
post/v1/remittersCreate new remitter
get/v1/remitters/{remitter_id}Get remitter detail.
delete/v1/remitters/{remitter_id}Delete remitter
get/v1/transfersGet list of transfers
post/v1/transfersCreate a new transfer
get/v1/transfers/{transfer_id}Get transfer by ID
post/v1/transfers/estimateEstimate transfer fees
get/v1/customersGet All Customers
post/v1/customersCreate a customer
get/v1/customers/{customer_id}Get Customer Detail
delete/v1/customers/{customer_id}Delete Customer
patch/v1/customers/{customer_id}Update Customer
get/v1/productsGet All Products
post/v1/productsCreate a Product
get/v1/products/{product_id}Get Product Detail
delete/v1/products/{product_id}Delete a Product
patch/v1/products/{product_id}Update the product
get/v1/couponsList Coupons
post/v1/couponsCreate Coupon
get/v1/coupons/{coupon_id}Get Coupon Details
put/v1/coupons/{coupon_id}Update Coupon
delete/v1/coupons/{coupon_id}Delete Coupon
patch/v1/coupons/{coupon_id}Update Coupon (PATCH)
get/v1/product-categoryGet All Product Category
get/v1/notificationsGet Notifications Setting
put/v1/notificationsUpdate Notifications Setting
get/v1/webhook-eventsGet All Webhook Events
post/v1/webhook-eventsCreate a Webhook Event
get/v1/webhook-events/{webhook_event_id}Get Webhook Event Detail
put/v1/webhook-events/{webhook_event_id}Update Webhook Event
delete/v1/webhook-events/{webhook_event_id}Delete Webhook Event
get/v1/static_qrGet All Static QRs
post/v1/static_qrCreate a Static QR
get/v1/static_qr/{static_qr_id}Get Static QR Detail
put/v1/static_qr/{static_qr_id}Update Static QR
delete/v1/static_qr/{static_qr_id}Delete the static QR
get/v1/readersGet all card readers
post/v1/readers/cancelCancel the terminal reader

Location

Changes to List locations

get/v1/locations

Aug 6, 20266aae1a736990 Revision changes
- info
  endpoint added