GetPayoutResponse

payout objectrequired

Payout object

completedAt object

oneOf

• null
• string<Instant>

null

createdAtstring<Instant>required

The date and time when the payout was created. Format: ISO 8601. Example: 2021-12-31T23:59:59.111Z

Possible values: <= 2147483647 characters

description object

The description of the payout. Example: 'Monthly payroll'

oneOf

• null
• string

null

idstring<uuid>required

The unique identifier of the payout. Format: UUID. Example: 123e4567-e89b-12d3-a456-426614174000

Possible values: >= 36 characters and <= 36 characters

name object

The name of the payout. Example: 'Payroll'

oneOf

• null
• string

null

paidAmount object

oneOf

• null
• Money

null

paidTransfersnumber<int32>required

The number of transfers that were paid. Example: 100

Possible values: >= -2147483648 and <= 2147483647

startedAt object

oneOf

• null
• string<Instant>

null

statePubApiPayoutPayoutState (string)required

The state of the payout. Possible values: CREATED, STARTED, COMPLETED

Possible values: [CREATED, STARTED, COMPLETED, CANCELED, PAUSED]

totalAmount object

oneOf

• null
• Money

null

totalTransfersnumber<int32>required

The total number of transfers in the payout. Example: 100

Possible values: >= -2147483648 and <= 2147483647

transfers object[]required

List of transfers

Possible values: <= 30

Array [

anyOf

• CryptoTransfer
• FiatTransfer
• InternalTransfer

amount objectrequired

The amount of the transfer

amountstringrequired

The amount of money. Example: 1000.12

Possible values: non-empty and <= 2147483647 characters

currencystringrequired

The currency of the money. Example: 'USD'

Possible values: non-empty and <= 10 characters

amountWithFee objectrequired

The amount of the transfer including fees

amountstringrequired

The amount of money. Example: 1000.12

Possible values: non-empty and <= 2147483647 characters

currencystringrequired

The currency of the money. Example: 'USD'

Possible values: non-empty and <= 10 characters

completedAt object

oneOf

• null
• string<Instant>

null

createdAtstring<Instant>required

The date and time when the transfer was created. Example: 2021-07-01T12:00:00.000Z

Possible values: <= 2147483647 characters

fromAccount object

oneOf

• null
• FromAccount

null

idstring<uuid>required

The unique identifier of the transfer. Example: 123e4567-e89b-12d3-a456-426614174000

Possible values: >= 36 characters and <= 36 characters

reference object

The description of the transfer

oneOf

• null
• string

null

statusTransferStatus (string)required

The status of the transfer. Example: COMPLETED

Possible values: [POSTPONED, PENDING, SUSPENDED, COMPLETED, FAILED]

toAccount objectrequired

Account to deposit

addressstringrequired

Crypto address. Example: 1Lbcfr7sAHTD9CgdQo3HTMTkV8LK4ZnX71 (Bitcoin network)

Possible values: <= 100 characters

idstring<uuid>required

The unique identifier of the account. Example: 123e4567-e89b-12d3-a456-426614174000

Possible values: <= 2147483647 characters

name object

The name of the beneficiary. Example: John Doe

oneOf

• null
• string

null

networkCryptoTransferNetworkId (string)required

The network of the crypto. Example: ERC20 or TRC20

Possible values: [ERC20, TRC20, BEP20, POLYGON, ARBITRUM, BASE, CARDANO, TEZOS, BTC_LEGACY, BTC_SEGWIT, HAQQ, SOLANA, TON]

totalFee objectrequired

The total fee of the transfer

amountstringrequired

The amount of money. Example: 1000.12

Possible values: non-empty and <= 2147483647 characters

currencystringrequired

The currency of the money. Example: 'USD'

Possible values: non-empty and <= 10 characters

typestringrequired

Possible values: [Crypto]

]

GetPayoutResponse

{
  "payout": {
    "completedAt": "null",
    "createdAt": "string",
    "description": "null",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "null",
    "paidAmount": "null",
    "paidTransfers": 0,
    "startedAt": "null",
    "state": "CREATED",
    "totalAmount": "null",
    "totalTransfers": 0
  },
  "transfers": [
    {
      "amount": {
        "amount": "string",
        "currency": "string"
      },
      "amountWithFee": {
        "amount": "string",
        "currency": "string"
      },
      "completedAt": "null",
      "createdAt": "string",
      "fromAccount": "null",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "reference": "null",
      "status": "POSTPONED",
      "toAccount": {
        "address": "string",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "null",
        "network": "ERC20"
      },
      "totalFee": {
        "amount": "string",
        "currency": "string"
      }
    },
    {
      "amount": {
        "amount": "string",
        "currency": "string"
      },
      "amountWithFee": {
        "amount": "string",
        "currency": "string"
      },
      "completedAt": "null",
      "createdAt": "string",
      "fromAccount": "null",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "reference": "null",
      "status": "POSTPONED",
      "toAccount": {
        "accountNumber": "string",
        "beneficiaryName": "string",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "routingNumber": "string"
      },
      "totalFee": {
        "amount": "string",
        "currency": "string"
      }
    },
    {
      "amount": {
        "amount": "string",
        "currency": "string"
      },
      "amountWithFee": {
        "amount": "string",
        "currency": "string"
      },
      "completedAt": "null",
      "createdAt": "string",
      "fromAccount": "null",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "reference": "null",
      "status": "POSTPONED",
      "toAccount": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "picture": "null",
        "username": "string"
      },
      "totalFee": {
        "amount": "string",
        "currency": "string"
      }
    }
  ]
}