POST
/
api
/
service
/
payout
/
retrieve
JavaScript
import Ivy from '@getivy/node-sdk';

const client = new Ivy({
  apiKey: 'My API Key',
});

const payout = await client.payouts.retrieve({ id: 'id' });

console.log(payout.id);
{
  "id": "<string>",
  "type": "beneficiary",
  "destination": {
    "type": "iban",
    "iban": {
      "accountHolderName": "<string>",
      "iban": "<string>",
      "bic": "<string>"
    },
    "sortCode": {
      "accountHolderName": "<string>",
      "sortCode": "<string>",
      "accountNumber": "<string>"
    },
    "bankCode": {
      "accountHolderName": "<string>",
      "code": "<string>",
      "accountNumber": "<string>"
    },
    "bban": {
      "accountHolderName": "<string>",
      "bban": "<string>",
      "bic": "<string>"
    }
  },
  "status": "paid",
  "amount": 123,
  "currency": "EUR",
  "metadata": {},
  "createdAt": "<any>",
  "updatedAt": "<any>",
  "paymentReference": "<string>",
  "transactionId": "<string>"
}

Authorizations

X-Ivy-Api-Key
string
header
required

API key for authentication

Body

application/json
id
string
required

The payout ID

Response

200 - application/json

Retrieve a payout

id
string
required

The payout ID

type
enum<string>
required

The payout type

Available options:
beneficiary,
customer
destination
object
required

The payout destination

status
enum<string>
required

The payout status

Available options:
paid,
pending,
in_transit,
failed,
canceled
amount
number
required

The payout amount

currency
enum<string>
required

The payout currency

Available options:
EUR,
GBP,
PLN,
SEK,
DKK
createdAt
any
required

The payout created at

updatedAt
any
required

The payout updated at

metadata
object

The payout metadata

paymentReference
string

The payout payment reference

transactionId
string

The payout transaction ID