Sign in
Global Payout Batches

Get a global payout batch

get/v1/global-payout-batches/{id}

Path parameters

idstring required
Example:pb_abc123

Headers

X-API-Keystring

API key

Response

Global payout batch retrieved

idstring required
organizationIdstring required
onBehalfOfstring required
status'DRAFT' | 'PENDING_APPROVAL' | 'PROCESSING' | 'COMPLETED' | 'PARTIALLY_COMPLETED' | 'FAILED' | 'CANCELLED' | 'REJECTED' required
paymentReason'CAPITAL_CONTRIBUTIONS' | 'CHARITABLE_CONTRIBUTIONS' | 'CONSULTING_FEES' | 'CORPORATE_TAX_PAYMENTS' | 'DOWN_PAYMENTS_FOR_REAL_ESTATE' | 'EDUCATION_FEES' | 'EMPLOYEE_SALARIES_OR_WAGES' | 'EXPENSES_REIMBURSEMENT' | 'GIFTS' | 'GOVERNMENT_GRANTS' | 'INCOME_TAX_PAYMENTS' | 'INHERITANCE_PAYMENTS' | 'INSURANCE_CLAIM_PAYOUTS' | 'INSURANCE_PREMIUM_PAYMENTS' | 'INVESTMENTS' | 'LOAN_ADVANCES' | 'MORTGAGE_PAYMENTS' | 'OTHER' | 'PAYMENT_FOR_GOODS_AND_SERVICES' | 'PERSONAL_TRANSFERS' | 'REAL_ESTATE_PURCHASES' | 'REMITTANCES' | 'RENT' | 'REPAYMENT_OF_LOANS' | 'ROYALTIES' | 'SELF' | 'TRADE_SETTLEMENT' | 'TRUST_FUND_DISTRIBUTIONS' | 'UTILITY_BILLS' | 'WELFARE_OR_BENEFITS' | 'WINNINGS_AND_PRIZES' required
rejectionReasonstring nullable

Reason when the batch was rejected during review.

createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "id": "pb_abc123",
  "organizationId": "org_abc123",
  "onBehalfOf": "cus_abc123",
  "source": {
    "currency": "USDT",
    "paymentRail": "ETHEREUM"
  },
  "status": "DRAFT",
  "paymentReason": "PAYMENT_FOR_GOODS_AND_SERVICES",
  "items": [
    {
      "id": "pbi_abc123",
      "amount": {
        "currency": "USD",
        "exponent": 2,
        "value": "12345",
        "displayValue": "123.45"
      },
      "counterpartyId": "cp_abc123",
      "destination": {
        "type": "EXTERNAL_WALLET",
        "currency": "USDT",
        "paymentRail": "ETHEREUM",
        "accountId": "ewa_abc123",
        "address": "0x1234567890abcdef1234567890abcdef12345678"
      },
      "transferId": "tfr_abc123",
      "status": "PENDING",
      "clientReferenceId": "payroll_line_42",
      "developerFeeFixed": 100,
      "developerFeePercent": 0.015
    }
  ]
}

Changes

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