BackBase · Schema

PaymentOrderGet

BankingFintechDigital BankingAPI PlatformAI-Native

Properties

Name	Type	Description
approvalDetails	object
id	string	Unique identification of the payment order.
approvalId	string	The id of the approval request that is or was used to get this item approved.
status	string	The internal DBS status of the payment order..
bankStatus	string	Internal status of the payment or batch order in the core banking system.
reasonCode	string	Reason code the core banking system accepted/rejected the payment or batch.
reasonText	string	Human readable reason the core banking system accepted/rejected the payment or batch.
errorDescription	string	Additional information from the core banking system on why the payment was refused.
createdBy	string	Creator user info.
createdAt	string	Date and time indicating when the payment was created
updatedBy	string	Updater user info.
updatedAt	string	Date and time indicating when the payment was updated
actions	object
version	integer	Indication of what version the payment order currently has
contextualInformation	object
intraLegalEntity	boolean	Indication if this payment was an intra-company payment.
originatorAccountCurrency	string	Currency code of the payment order originating account
confirmationId	string	The confirmation id for transaction signing.
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
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
totalAmount	object
additions	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/backbase/main/json-schema/backbase-payment-order-get-response-schema.json",
  "title": "PaymentOrderGet",
  "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/PaymentOrderGetResponse",
  "required": [
    "id",
    "status",
    "version"
  ],
  "type": "object",
  "properties": {
    "approvalDetails": {
      "$ref": "#/$defs/PresentationApprovalDetailDto"
    },
    "id": {
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
      "type": "string",
      "description": "Unique identification of the payment order."
    },
    "approvalId": {
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
      "type": "string",
      "description": "The id of the approval request that is or was used to get this item approved."
    },
    "status": {
      "type": "string",
      "description": "The internal DBS status of the payment order..",
      "enum": [
        "DRAFT",
        "ENTERED",
        "READY",
        "ACCEPTED",
        "PROCESSED",
        "REJECTED",
        "CANCELLED",
        "CANCELLATION_PENDING",
        "CONFIRMATION_PENDING",
        "CONFIRMATION_DECLINED"
      ]
    },
    "bankStatus": {
      "maxLength": 35,
      "type": "string",
      "description": "Internal status of the payment or batch order in the core banking system."
    },
    "reasonCode": {
      "maxLength": 4,
      "type": "string",
      "description": "Reason code the core banking system accepted/rejected the payment or batch."
    },
    "reasonText": {
      "maxLength": 35,
      "type": "string",
      "description": "Human readable reason the core banking system accepted/rejected the payment or batch."
    },
    "errorDescription": {
      "maxLength": 105,
      "type": "string",
      "description": "Additional information from the core banking system on why the payment was refused."
    },
    "createdBy": {
      "maxLength": 128,
      "type": "string",
      "description": "Creator user info."
    },
    "createdAt": {
      "type": "string",
      "description": "Date and time indicating when the payment was created",
      "format": "date-time"
    },
    "updatedBy": {
      "maxLength": 128,
      "type": "string",
      "description": "Updater user info."
    },
    "updatedAt": {
      "type": "string",
      "description": "Date and time indicating when the payment was updated",
      "format": "date-time"
    },
    "actions": {
      "$ref": "#/$defs/Actions"
    },
    "version": {
      "type": "integer",
      "description": "Indication of what version the payment order currently has",
      "format": "int32"
    },
    "contextualInformation": {
      "$ref": "#/$defs/ContextualInformation"
    },
    "intraLegalEntity": {
      "type": "boolean",
      "description": "Indication if this payment was an intra-company payment."
    },
    "originatorAccountCurrency": {
      "pattern": "^[A-Z]{3}$",
      "type": "string",
      "description": "Currency code of the payment order originating account"
    },
    "confirmationId": {
      "maxLength": 36,
      "minLength": 1,
      "type": "string",
      "description": "The confirmation id for transaction signing."
    },
    "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"
    },
    "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"
    },
    "totalAmount": {
      "$ref": "#/$defs/Currency"
    },
    "additions": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "$defs": {
    "Actions": {
      "type": "array",
      "description": "An array of actions that could be performed on a payment order. Actions that can be done are dependant on the payment itself.",
      "items": {
        "type": "string",
        "description": "The actions that can be performed by the user (with the current context). This field is not evaluated when payment is requested by support employee on behalf of another user.",
        "enum": [
          "APPROVE",
          "FINAL_APPROVE",
          "REJECT",
          "CANCEL",
          "DELETE"
        ]
      }
    },
    "ApprovalTypeDto": {
      "required": [
        "id",
        "name",
        "rank"
      ],
      "type": "object",
      "properties": {
        "id": {
          "pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[1-5][0-9a-fA-F]{3}-?[89abAB][0-9a-fA-F]{3}-?[0-9a-fA-F]{12}$",
          "type": "string",
          "description": "Universal Unique Identifier, "
        },
        "name": {
          "maxLength": 50,
          "type": "string",
          "description": "The name of an item."
        },
        "description": {
          "maxLength": 255,
          "type": "string",
          "description": "This gives a more in detailed description of the item and its purpose."
        },
        "rank": {
          "minimum": 1,
          "type": "integer",
          "description": "The rank determines which item takes precedence over another. 1 means highest precedence and 100 takes lower precedence than 10. Must be unique!",
          "format": "int32"
        }
      },
      "description": "An approval type, also known as approval level, is used to allow a hierarchy of approvals to grant to various users or groups to allow complex policies to be defined."
    },
    "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."
    },
    "ContextualInformation": {
      "required": [
        "externalUserId",
        "origin",
        "serviceAgreementId"
      ],
      "type": "object",
      "properties": {
        "externalUserId": {
          "maxLength": 64,
          "type": "string",
          "description": "The (unique and human readable) external user id of the user."
        },
        "internalUserId": {
          "maxLength": 36,
          "minLength": 1,
          "type": "string",
          "description": "General purpose identifier. Can be UUID but does not have to."
        },
        "serviceAgreementId": {
          "maxLength": 36,
          "minLength": 1,
          "type": "string",
          "description": "General purpose identifier. Can be UUID but does not have to."
        },
        "legalEntityId": {
          "maxLength": 36,
          "minLength": 1,
          "type": "string",
          "description": "General purpose identifier. Can be UUID but does not have to."
        },
        "origin": {
          "maxLength": 200,
          "minLength": 1,
          "type": "string",
          "description": "Name the system where endpoint is calling from"
        }
      }
    },
    "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."
    },
    "LogicalPolicyDetailsDto": {
      "type": "object",
      "properties": {
        "rank": {
          "minimum": 0,
          "type": "integer",
          "description": "Rank of this logical operation with 1 as the highest precedence. The rank is unique inside the details list.",
          "format": "int32"
        },
        "operator": {
          "type": "string",
          "description": "Type of logical operation, please see Community for each operation implementation",
          "enum": [
            "OR"
          ]
        },
        "items": {
          "maxItems": 5,
          "minItems": 0,
          "type": "array",
          "description": "List of policy items inside this logical operation.",
          "items": {
            "$ref": "#/$defs/PolicyItemDetailsDto"
          },
          "default": []
        }
      },
      "description": "A policy declaration that allows you to add logical operators to the contained policy items."
    },
    "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"
    },
    "PolicyItemDetailsDto": {
      "required": [
        "approvalType",
        "numberOfApprovals"
      ],
      "type": "object",
      "properties": {
        "approvalType": {
          "$ref": "#/$defs/ApprovalTypeDto"
        },
        "numberOfApprovals": {
          "maximum": 99,
          "minimum": 1,
          "type": "integer",
          "description": "The number of a certain type of approval that is required.",
          "format": "int32"
        }
      },
      "description": "A detailed policy item with the full approval type."
    },
    "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"
    },
    "PresentationApprovalDetailDto": {
      "required": [
        "approvalTypes",
        "createdAt",
        "function",
        "id",
        "itemId",
        "policy",
        "resource",
        "serviceAgreementId",
        "status",
        "userId"
      ],
      "properties": {
        "approvalTypes": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/PresentationApprovalTypeDto"
          }
        },
        "policy": {
          "$ref": "#/$defs/PresentationPolicyDto"
        },
        "id": {
          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
          "type": "string",
          "description": "Universally Unique Identifier (UUID)."
        },
        "userId": {
          "maxLength": 36,
          "minLength": 1,
          "type": "string",
          "description": "General purpose identifier. Can be UUID but does not have to."
        },
        "externalUserId": {
          "maxLength": 64,
          "type": "string",
          "description": "The (unique and human readable) external user id of the user."
        },
        "userFullName": {
          "maxLength": 255,
          "minLength": 1,
          "type": "string",
          "description": "The full name of a user."
        },
        "serviceAgreementId": {
          "maxLength": 36,
          "minLength": 1,
          "type": "string",
          "description": "General purpose identifier. Can be UUID but does not have to."
        },
        "itemId": {
          "maxLength": 36,
          "minLength": 1,
          "type": "string",
          "description": "General purpose identifier. Can be UUID but does not have to."
        },
        "dataAccessItemId": {
          "maxLength": 36,
          "minLength": 1,
          "type": "string",
          "description": "General purpose identifier. Can be UUID but does not have to."
        },
        "resource": {
          "maxLength": 32,
          "type": "string",
          "description": "This is the name of the resource."
        },
        "function": {
          "maxLength": 32,
          "type": "string",
          "description": "This is the name of the business function."
        },
        "status": {
          "type": "string",
          "description": "The status of the approval.",
          "enum": [
            "PENDING",
            "APPROVED",
            "REJECTED",
            "CANCELLED"
          ]
        },
        "records": {
          "type": "array",
          "description": "A list of records of all the approve and reject actions on the approval.",
          "items": {
            "$ref": "#/$defs/PresentationRecordDto"
          }
        },
        "canApprove": {
          "type": "boolean",
          "description": "This flag indicates if the user (with the current context) that is requesting the approval can approve it, depending on the policy that applies. In case a support employee requests the payment on behalf of another user, this flag is indicating whether the target user can approve the item and not the support employee himself."
        },
        "canReject": {
          "type": "boolean",
          "description": "This flag indicates if the user (with the current context) that is requesting the approval can reject it, depending on the policy that applies. In case a support employee requests the payment on behalf of another user, this flag is indicating whether the target user can reject the item and not the support employee himself."
        },
        "finalApprover": {
          "type": "boolean",
          "description": "This flag indicates if the user (with the current context) is the final approver that is needed. In case a support employee requests the payment on behalf of another user, this flag is indicating whether the target user is a final approver and not the support employee himself."
        },
        "action": {
          "maxLength": 20,
          "type": "string",
          "description": "The action of the approval request"
        },
        "createdAt": {
          "type": "string",
          "description": "The timestamp indicates when the object was created.",
          "format": "date-time"
        }
      },
      "description": "A detailed approval object that holds extended details of a single item to be approved."
    },
    "PresentationApprovalTypeDto": {
      "required": [
        "id",
        "name",
        "rank"
      ],
      "type": "object",
      "properties": {
        "id": {
          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
          "type": "string",
          "description": "Universally Unique Identifier (UUID)."
        },
        "name": {
          "maxLength": 50,
          "type": "string",
          "description": "The name of an item."
        },
        "description": {
          "maxLength": 255,
          "type": "string",
          "description": "This gives a more in detailed description of the item and its purpose."
        },
        "rank": {
          "minimum": 1,
          "type": "integer",
          "description": "The rank determines which item takes precedence over another. 1 means highest precedence and 100 takes lower precedence than 10. Must be unique!",
          "format": "int32"
        }
      },
      "description": "A simple object that represents a type of approval that can be placed on an approval."
    },
    "PresentationPolicyDto": {
      "required": [
        "id",
        "name"
      ],
      "type": "object",
      "properties": {
        "id": {
          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
          "type": "string",
          "description": "Universally Unique Identifier (UUID)."
        },
        "name": {
          "maxLength": 140,
          "type": "string",
          "description": "Default name field used in DBS"
        },
        "description": {
          "maxLength": 255,
          "type": "string",
          "description": "This gives a more in detailed description of the item and its purpose."
        },
        "items": {
          "type": "array",
          "description": "A list of approval types and the number of each approval type is required. If there are 0 items a zero-approval-policy applies.",
          "items": {
            "$ref": "#/$defs/PresentationPolicyItemDto"
          }
        },
        "logicalItems": {
          "type": "array",
          "description": "Contains a list of logical approval policy items. These items have been used in the calculation of this approval state.",
          "items": {
            "$ref": "#/$defs/LogicalPolicyDetailsDto"
          }
        }
      },
      "description": "This object describes how a policy is built up. It tells you what policies apply (#policyItems) or if you can self-approve."
    },
    "PresentationPolicyItemDto": {
      "required": [
        "approvalTypeId",
        "numberOfApprovals"
      ],
      "type": "object",
      "properties": {
        "approvalTypeId": {
          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
          "type": "string",
          "description": "Universally Unique Identifier (UUID)."
        },
        "numberOfApprovals": {
          "type": "integer",
          "description": "The number of a certain type of approval that is required.",
          "format": "int32"
        }
      }
    },
    "PresentationRecordDto": {
      "required": [
        "approvalTypeId",
        "createdAt",
        "id",
        "status",
        "userId"
      ],
      "type": "object",
      "properties": {
        "id": {
          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
          "type": "string",
          "description": "Universally Unique Identifier (UUID)."
        },
        "userId": {
          "maxLength": 36,
          "minLength": 1,
          "type": "string",
          "description": "General purpose identifier. Can be UUID but does not have to."
        },
        "externalUserId": {
          "maxLength": 64,
          "type": "string",
          "description": "The (unique and human readable) external user id of the user."
        },
        "userFullName": {
          "maxLength": 255,
          "minLength": 1,
          "type": "string",
          "description": "The full name of a user."
        },
        "approvalTypeId": {
          "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
          "type": "string",
          "description": "Universally Unique Identifier (UUID)."
        },
        "status": {
          "type": "string",
          "description": "The list of accepted statuses that a user can request to update an approval to.",
          "enum": [
            "APPROVED",
            "REJECTED"
          ]
        },
        "createdAt": {
          "type": "string",
          "description": "The timestamp indicates when the object was created.",
          "format": "date-time"
        },
        "comment": {
          "maxLength": 140,
          "type": "string",
          "description": "When approving or rejecting, the user can add comments which would explain the reason for the action."
        }
      },
      "description": "A single record of either an approval or rejection by a user on an approval request."
    },
    "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-order-get-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.