FiatPayoutApiDTO

  • accountNumber
    Type: string
    required

    Destination bank account IBAN or local account number (e.g. UK 8-digit account number)

  • amount
    Type: number
    required

    Amount to send

  • bankCode
    Type: string
    required

    Bank identifier. Interpreted by destination: ACH routing number for USD→US, UK sort code for GBP→GB, SWIFT/BIC otherwise.

  • bankName
    Type: string
    required

    Name of the destination bank

  • beneficiaryRelationship
    Type: stringenum
    required

    Relationship to the beneficiary (required when currency is USD)

    values
    • EMPLOYEE
    • CONTRACTOR
    • VENDOR
    • SUBSIDIARY
    • MERCHANT
    • CUSTOMER
    • LANDLORD
    • FAMILY
    • OTHER
  • beneficiaryType
    Type: stringenum
    required

    Beneficiary type

    values
    • BUSINESS
    • INDIVIDUAL
  • city
    Type: string
    required

    City

  • countryCode
    Type: stringenum
    required

    Destination country code (ISO 3166-1 alpha-2)

    values
    • AL
    • DZ
    • AG
    • AR
    • AM
  • currency
    Type: stringenum
    required

    Fiat currency

    values
    • USD
    • EUR
    • GBP
  • postalCode
    Type: string
    required

    Postal code

  • reference
    Type: string
    required

    Payment reference (max 30 chars, alphanumeric)

  • streetAddress
    Type: string
    required

    Street address

  • businessName
    Type: string

    Business legal name (required if beneficiaryType is BUSINESS)

  • firstName
    Type: string

    Beneficiary first name (required if beneficiaryType is INDIVIDUAL)

  • lastName
    Type: string

    Beneficiary last name (required if beneficiaryType is INDIVIDUAL)

  • paymentPurpose
    Type: string

    Purpose of payment

  • paymentPurposeAttachmentId
    Type: string

    Id of a file previously uploaded via POST /v1/files. Pass the value of data.id from that response here verbatim.