IvoryPay API Documentation
  • Authorization
    • Using your API key
  • Webhook
  • Country
  • Currency
  • Exchange Rates
  • Accept a payment
    • Initiate a transaction
    • Verify transaction
    • Pay Via Wallet Connection
  • Payment Link
    • Create a payment link
    • Update a payment link
    • Fetch payment links
    • Fetch a payment link
    • Delete a payment link
    • Initiate a payment link transaction
  • Customer
    • Add a customer
    • Update a customer
    • Fetch customers
    • Fetch a customer
    • Remove a customer
  • Swap
    • Initiate a swap
    • Fetch a swap
    • Execute a swap
  • Bank
    • Fetch banks
    • Resolve Bank Account Name
  • Bank Detail
    • Add a bank detail
    • Fetch bank details
    • Remove a bank detail
  • Payout Request
    • Create on-chain payout request
    • Create bank payout request
    • Cancel a payout request
  • Virtual Bank Account
    • Create a private customer virtual account
    • Create a business customer virtual account
    • Fetch virtual accounts
    • Simulate a transfer to a virtual account
  • Packages and SDKs
    • React Native
    • Flutter
Powered by GitBook
On this page

Payout Request

Payout Request is how you can withdraw your funds from your managed IvoryPay wallets.

The IvoryPay Payout Request API allows you to create and cancel On-Chain and Off-Chain payout request. An On-Chain payout request is simply a withdrawal you make to an external wallet address. Off-Chain payout requests, on the other hand, are withdrawals you make to a local bank account.

A payout request can be in the following states:

  • PENDING (Default): Your request has just been created and can be cancelled by you.

  • PROCESSING: Your request is now being processed and may no longer be cancelled.

  • FULFILLED: Your request is has been fulfilled and payout has been made to you.

  • DECLINED: You request could not be fulfilled and payout could not be made to you.

  • CANCELLED: Your request was cancelled by you before being processed.

PreviousRemove a bank detailNextCreate on-chain payout request

Last updated 1 year ago