Skip to main content

ScheduledPayments

  • Array [
  • idstring<uuid>
    amount object
    amountnumberrequired
    Example: 123.45
    currencyCurrency (string)required

    ISO 4217 currency code

    Example: USD, EUR, AUD, NZD
    nicknamestring
    payeeReferencestring
    payerReferencestring
    status"string
    typePayeeType (string)

    Possible values: [BILLER, DIGITAL_WALLET, DOMESTIC, INTERNATIONAL]

    subTypePayeeSubtype (string)

    Possible values: [ACCOUNT, CARD, PAYID, BILLER]

    payeeDetails object
    namestring
    accountNumber object
    schemeNumberScheme (string)required

    Possible values: [SORTCODE, IBAN, PAN, BIC, BBAN_SE, BBAN_DK, BBAN_NO, BECS, BSB_NO, MASKED, UNKNOWN, ABN, EMAIL, TELEPHONE, BPAY, ORG_ID]

    numberstringrequired
  • ]
  • ScheduledPayments
    [
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "amount": {
    "amount": 123.45,
    "currency": "USD, EUR, AUD, NZD"
    },
    "nickname": "string",
    "payeeReference": "string",
    "payerReference": "string",
    "status\"": "string",
    "type": "BILLER",
    "subType": "ACCOUNT",
    "payeeDetails": {
    "name": "string",
    "accountNumber": {
    "scheme": "SORTCODE",
    "number": "string"
    }
    }
    }
    ]