BackBase · Schema

PaymentOrdersValidatePostResponse

BankingFintechDigital BankingAPI PlatformAI-Native

Properties

Name Type Description
originatorAccount object
batchBooking boolean Indicate whenever there should be only one debit posting for the whole set of instructions
instructionPriority string Specify the priority of execution of the payment order.
requestedExecutionDate string The preferred date for the payment order to be executed.
paymentMode string Denotes whether payment will be single or will be recurring
paymentType string The type of payment.
entryClass string Used for ACH Standard Entry Class (SEC) Code to designate how the transaction was authorized by the originator.
schedule object
transferTransactionInformation object
paymentSetupId string Generated when the PISP sets up the payments before the Backbase authorization flow.
paymentSubmissionId string Generated when the PISP submits the payment which is after the Backbase authorization flow.
originator object
totalAmount object
isIntraLegalEntityPaymentOrder boolean This flag is true to indicate the validated payment order is a payment order between two accounts within the same legal entity.
canApprove boolean This flag is true to indicate that an approval can be created and approved by the current user for the validated payment order.
finalApprover boolean This flag is true to indicate that the current user will be the final approver for the validated payment order.
additions object
View JSON Schema on GitHub

JSON Schema

backbase-payment-orders-validate-post-response-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/backbase/main/json-schema/backbase-payment-orders-validate-post-response-schema.json",
  "title": "PaymentOrdersValidatePostResponse",
  "x-generated": "2026-09-27",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/payment-order-client-api-v2.0.0.yaml#/components/schemas/PaymentOrdersValidatePostResponse",
  "required": [
    "canApprove",
    "finalApprover",
    "isIntraLegalEntityPaymentOrder"
  ],
  "type": "object",
  "properties": {
    "originatorAccount": {
      "$ref": "#/$defs/OriginatorAccount"
    },
    "batchBooking": {
      "type": "boolean",
      "description": "Indicate whenever there should be only one debit posting for the whole set of instructions"
    },
    "instructionPriority": {
      "type": "string",
      "description": "Specify the priority of execution of the payment order.",
      "enum": [
        "NORM",
        "HIGH"
      ]
    },
    "requestedExecutionDate": {
      "type": "string",
      "description": "The preferred date for the payment order to be executed.",
      "format": "date"
    },
    "paymentMode": {
      "type": "string",
      "description": "Denotes whether payment will be single or will be recurring",
      "enum": [
        "SINGLE",
        "RECURRING"
      ]
    },
    "paymentType": {
      "maxLength": 22,
      "minLength": 1,
      "type": "string",
      "description": "The type of payment."
    },
    "entryClass": {
      "maxLength": 3,
      "type": "string",
      "description": "Used for ACH Standard Entry Class (SEC) Code to designate how the transaction was authorized by the originator."
    },
    "schedule": {
      "$ref": "#/$defs/Schedule"
    },
    "transferTransactionInformation": {
      "$ref": "#/$defs/IdentifiedTransaction"
    },
    "paymentSetupId": {
      "maxLength": 128,
      "type": "string",
      "description": "Generated when the PISP sets up the payments before the Backbase authorization flow."
    },
    "paymentSubmissionId": {
      "maxLength": 128,
      "type": "string",
      "description": "Generated when the PISP submits the payment which is after the Backbase authorization flow."
    },
    "originator": {
      "$ref": "#/$defs/InvolvedParty"
    },
    "totalAmount": {
      "$ref": "#/$defs/Currency"
    },
    "isIntraLegalEntityPaymentOrder": {
      "type": "boolean",
      "description": "This flag is true to indicate the validated payment order is a payment order between two accounts within the same legal entity."
    },
    "canApprove": {
      "type": "boolean",
      "description": "This flag is true to indicate that an approval can be created and approved by the current user for the validated payment order."
    },
    "finalApprover": {
      "type": "boolean",
      "description": "This flag is true to indicate that the current user will be the final approver for the validated payment order."
    },
    "additions": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "$defs": {
    "Bank": {
      "type": "object",
      "properties": {
        "bankBranchCode": {
          "maxLength": 11,
          "type": "string",
          "description": "Some code to identify a bank office, p.e. ABA routing transit number (9) or Swift BIC code (11)"
        },
        "name": {
          "maxLength": 140,
          "type": "string",
          "description": "The name of a bank"
        },
        "postalAddress": {
          "$ref": "#/$defs/PostalAddress"
        },
        "bic": {
          "pattern": "^([A-Z0-9]){4}([A-Z]){2}([A-Z0-9]){2}([A-Z0-9]{3})?$",
          "type": "string",
          "description": "Business identifier code as specified by ISO 9362:2014"
        }
      },
      "description": "This object is used to identify the counterparty or correspondent bank."
    },
    "CounterpartyAccount": {
      "required": [
        "identification"
      ],
      "properties": {
        "accountType": {
          "maxLength": 10,
          "type": "string",
          "description": "The type of the account, e.g. for ACH we have CHECKING/SAVINGS"
        },
        "arrangementId": {
          "maxLength": 36,
          "minLength": 1,
          "type": "string",
          "description": "The unique arrangement id."
        },
        "externalArrangementId": {
          "maxLength": 70,
          "minLength": 1,
          "type": "string",
          "description": "The external unique arrangement id."
        },
        "identification": {
          "$ref": "#/$defs/Identification"
        },
        "name": {
          "maxLength": 140,
          "type": "string",
          "description": "Default name field used in DBS"
        }
      },
      "description": "The counterparty Account is the original account identification plus the arrangement if applicable."
    },
    "Currency": {
      "$ref": "#/$defs/currency"
    },
    "ExchangeRateInformation": {
      "type": "object",
      "properties": {
        "currencyCode": {
          "pattern": "^[A-Z]{3}$",
          "type": "string",
          "description": "Currency in which the rate of exchange is expressed in a currency exchange."
        },
        "rate": {
          "maximum": 1e+18,
          "minimum": -1e+18,
          "type": "string",
          "description": "The factor used for conversion of an amount from one currency to another."
        },
        "rateType": {
          "type": "string",
          "description": "Specifies the type used to complete the currency exchange.",
          "enum": [
            "ACTUAL",
            "INDICATIVE",
            "AGREED"
          ]
        },
        "contractIdentification": {
          "maxLength": 256,
          "type": "string",
          "description": "Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent."
        }
      },
      "description": "The detailed information on the exchange rate that has been used in the payment transaction."
    },
    "Identification": {
      "required": [
        "identification",
        "schemeName"
      ],
      "type": "object",
      "properties": {
        "identification": {
          "maxLength": 36,
          "type": "string",
          "description": "The identifier of the account. Can be a regular account number, or an ID."
        },
        "schemeName": {
          "type": "string",
          "description": "This describes the type of the account identifier. ID will mean it refers to an account known within DBS.",
          "enum": [
            "IBAN",
            "BBAN",
            "ID",
            "EXTERNAL_ID"
          ]
        }
      }
    },
    "IdentifiedTransaction": {
      "required": [
        "counterparty",
        "counterpartyAccount",
        "instructedAmount"
      ],
      "type": "object",
      "properties": {
        "counterparty": {
          "$ref": "#/$defs/InvolvedParty"
        },
        "counterpartyAccount": {
          "$ref": "#/$defs/CounterpartyAccount"
        },
        "counterpartyBank": {
          "$ref": "#/$defs/Bank"
        },
        "instructedAmount": {
          "$ref": "#/$defs/Currency"
        },
        "correspondentBank": {
          "$ref": "#/$defs/Bank"
        },
        "intermediaryBank": {
          "$ref": "#/$defs/Bank"
        },
        "messageToBank": {
          "maxLength": 140,
          "type": "string",
          "description": "The message to the bank used for US domestic wire payments"
        },
        "targetCurrency": {
          "pattern": "^[A-Z]{3}$",
          "type": "string",
          "description": "The alpha-3 code (complying with ISO 4217) of the currency"
        },
        "remittanceInformation": {
          "$ref": "#/$defs/RemittanceInformation"
        },
        "endToEndIdentification": {
          "maxLength": 35,
          "type": "string"
        },
        "mandateIdentifier": {
          "maxLength": 15,
          "type": "string",
          "description": "The mandate identifier, of the counter party, giving permission for the debit order."
        },
        "chargeBearer": {
          "type": "string",
          "description": "Indicated who pays the fees for an international transfer. Possible values: OUR(originator), BEN(beneficiary or SHA(shared).",
          "enum": [
            "OUR",
            "BEN",
            "SHA"
          ]
        },
        "transferFee": {
          "$ref": "#/$defs/Currency"
        },
        "exchangeRateInformation": {
          "$ref": "#/$defs/ExchangeRateInformation"
        }
      },
      "description": "The object defining the identified transaction, which means the counterparty will have a arrangementId where applicable."
    },
    "InvolvedParty": {
      "required": [
        "name"
      ],
      "type": "object",
      "properties": {
        "name": {
          "maxLength": 140,
          "type": "string"
        },
        "role": {
          "type": "string",
          "description": "These are the possible values the role of an involved party can  have.",
          "enum": [
            "CREDITOR",
            "DEBTOR"
          ]
        },
        "postalAddress": {
          "$ref": "#/$defs/PostalAddress"
        },
        "recipientId": {
          "maxLength": 15,
          "type": "string",
          "description": "Used for ACH Credit to indicate the id of the recipient"
        }
      },
      "description": "This object is a common denominator for the debtor or creditor party."
    },
    "OriginatorAccount": {
      "required": [
        "arrangementId",
        "identification"
      ],
      "properties": {
        "arrangementId": {
          "maxLength": 36,
          "minLength": 1,
          "type": "string",
          "description": "The unique arrangement id."
        },
        "externalArrangementId": {
          "maxLength": 70,
          "minLength": 1,
          "type": "string",
          "description": "The external unique arrangement id."
        },
        "identification": {
          "$ref": "#/$defs/Identification"
        },
        "name": {
          "maxLength": 140,
          "type": "string",
          "description": "This is the name of the account, and not the name of the account holder."
        }
      },
      "description": "The product identification of the originator"
    },
    "PostalAddress": {
      "type": "object",
      "properties": {
        "addressLine1": {
          "maxLength": 70,
          "type": "string"
        },
        "addressLine2": {
          "maxLength": 70,
          "type": "string"
        },
        "streetName": {
          "maxLength": 70,
          "type": "string"
        },
        "postCode": {
          "maxLength": 16,
          "type": "string"
        },
        "town": {
          "maxLength": 35,
          "type": "string"
        },
        "countrySubDivision": {
          "maxLength": 35,
          "type": "string"
        },
        "country": {
          "maxLength": 2,
          "type": "string"
        }
      },
      "description": "Postal address object with fields"
    },
    "RemittanceInformation": {
      "required": [
        "content",
        "type"
      ],
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "When type is structured it consists of some XML tags used when the transaction was uploaded.",
          "enum": [
            "STRUCTURED",
            "UNSTRUCTURED"
          ]
        },
        "content": {
          "maxLength": 140,
          "type": "string",
          "description": "The content of the remittance information."
        }
      },
      "description": "This is the object representation of the remittance info and can contain different types of remittance info. It is only used in responses, not for input requests!"
    },
    "Schedule": {
      "required": [
        "every",
        "on",
        "startDate",
        "transferFrequency"
      ],
      "type": "object",
      "properties": {
        "nonWorkingDayExecutionStrategy": {
          "type": "string",
          "description": "Strategy for executing payments on non-working days",
          "enum": [
            "BEFORE",
            "AFTER",
            "NONE"
          ]
        },
        "transferFrequency": {
          "type": "string",
          "description": "Denotes how frequently the transfer should be made",
          "enum": [
            "ONCE",
            "DAILY",
            "WEEKLY",
            "BIWEEKLY",
            "MONTHLY",
            "QUARTERLY",
            "YEARLY"
          ]
        },
        "on": {
          "type": "integer",
          "description": "Denotes day on which transfer should be executed. For WEEKLY transferFrequency it will be 1..7 indicating weekday. For BIWEEKLY it will be 1..14 indicating the day of the two week period. For MONTHLY it will be 1..31 indicating day of month. For YEARLY it will be 1..12 indicating month of the year.",
          "format": "int32"
        },
        "startDate": {
          "type": "string",
          "description": "When to start executing the schedule. First transfer will be executed on first calculated date by schedule after this date.",
          "format": "date"
        },
        "endDate": {
          "type": "string",
          "description": "When to stop transfers. Transfers will not be executed after this date. Only one of endDate and repeat is possible. If neither repeat nor endDate is provided transfer will be executed until canceled",
          "format": "date"
        },
        "repeat": {
          "type": "integer",
          "description": "Number of transfer to be executed. Only one of endDate and repeat is possible. If neither repeat nor endDate is provided transfer will be executed until canceled",
          "format": "int32"
        },
        "every": {
          "type": "integer",
          "description": "Indicates skip interval of transfer. 1 would mean execute every time, 2 - every other time",
          "format": "int32",
          "enum": [
            1,
            2
          ]
        },
        "nextExecutionDate": {
          "type": "string",
          "description": "Date when the next payment will be executed, taking in consideration bank holidays and cut-off times. It will be only retrieved when getting payments, it will be dismissed when creating or updating.",
          "format": "date"
        }
      },
      "description": "Schedule for recurring transfer. Mandatory if paymentMode is RECURRING"
    },
    "currency": {
      "title": "Currency",
      "required": [
        "amount",
        "currencyCode"
      ],
      "type": "object",
      "properties": {
        "amount": {
          "maximum": 1e+18,
          "minimum": -1e+18,
          "type": "string",
          "description": "The amount in the specified currency"
        },
        "currencyCode": {
          "pattern": "^[A-Z]{3}$",
          "type": "string",
          "description": "The alpha-3 code (complying with ISO 4217) of the currency that qualifies the amount"
        },
        "additions": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Additional properties"
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema 
curl "https://apis.io/api/v1/json-schemas/backbase-payment-orders-validate-post-response"
All schemas 
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.