Skip to main content
POST
/
api
/
service
/
payout
/
list
JavaScript
import Ivy from '@getivy/node-sdk';

const client = new Ivy({
  apiKey: process.env['IVY_API_KEY'], // This is the default and can be omitted
});

const payouts = await client.payouts.list();

console.log(payouts.count);
{
  "items": [
    {
      "id": "<string>",
      "destination": {
        "iban": {
          "accountHolderName": "<string>",
          "iban": "<string>",
          "bic": "<string>"
        },
        "aba": {
          "accountHolderName": "<string>",
          "routingNumber": "<string>",
          "accountNumber": "<string>"
        },
        "sortCode": {
          "accountHolderName": "<string>",
          "sortCode": "<string>",
          "accountNumber": "<string>"
        },
        "bankCode": {
          "accountHolderName": "<string>",
          "code": "<string>",
          "accountNumber": "<string>"
        },
        "bban": {
          "accountHolderName": "<string>",
          "bban": "<string>",
          "bic": "<string>"
        },
        "wallet": {
          "address": "<string>"
        }
      },
      "amount": 123,
      "createdAt": "<unknown>",
      "updatedAt": "<unknown>",
      "metadata": {},
      "paymentReference": "<string>",
      "transactionId": "<string>",
      "failure": {
        "message": "<string>",
        "retry": true
      }
    }
  ],
  "skip": 123,
  "count": 123,
  "hasNext": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.augustus.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Ivy-Api-Key
string
header
required

API key for authentication

Body

application/json
​
limit
number
Required range: 0 < x < 20
​
skip
number
Required range: 0 < x < 10000
​
type
enum<string>
Available options:
customer-payout,
beneficiary-payout

Response

200 - application/json

List payouts

​
items
object[]
required
​
skip
number
required
​
count
number
required
​
hasNext
boolean
required