AIairtm
Payouts

List payouts

List payouts

get/payouts

Request

Query parameters

beforestring

Gets results before the specified cursor.

afterstring

Gets results after the specified cursor.

perPageinteger

The maximum number of items to fetch.

status'BRIDGE_COMPLETED' | 'BRIDGE_CREATED' | 'BRIDGE_FAILED' | 'BRIDGE_MAX_RETRIES_REACHED' | 'BRIDGE_USER_SIGNUP_PENDING' | 'CANCELED' | 'CANCEL_REQUESTED' | 'COMMITTED' | 'COMPLETED' | 'COSMOEM_COMPLETED' | 'CREATED' | 'ERROR' | 'FAILED' | 'PENDING' | 'PENDING_SIGNATURE' | 'SIGNED' | 'PENDING_USER_ACTION' | 'PROCESSING'

The current status of the payout.

  • CREATED: The payout instruction has been registered and is awaiting you to call the commit endpoint.
  • COMMITTED: The payout was committed and is in the process of being executed.
  • PENDING: Funds have been placed in escrow and waiting for the recipient to take the following action to complete the payout
    1. If a new user, create an Airtm account.
    2. If a user receiving an amount taking them over the $1,000 inflow threshold requiring KYC.
    3. If a US user, complete KYC and configure payment method.
  • COMPLETED: The payout has been completed successfully, funds have been credited to the customer's account.
  • CANCELED: Payout has been canceled and funds have been returned to your account.
  • FAILED: The payout has failed and funds have been returned to your account.
  • ERROR: A temporary error state. Payouts in this state should be fixed and retried until they reach a final state (COMPLETED or CANCELED).
bulkPayoutIdstring

Response

Ok

startCursorstring

The cursor for the first item in the current page.

endCursorstring

The cursor for the last item in the current page.

Example response

{
  "items": [
    {
      "grossAmount": 10,
      "amount": 9.5,
      "netAmount": 9,
      "airtmFee": 0.5,
      "enterpriseFee": 0.5
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.