GetPayoutResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/openpayments-io/main/json-schema/openpayments-io-get-payout-response-schema.json",
  "title": "GetPayoutResponse",
  "x-generated": "2026-10-16",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/openpayments-io-openapi.yml#/components/schemas/GetPayoutResponse",
  "required": [
    "creditorAccount",
    "creditorName",
    "debtorAccount",
    "instructedAmount"
  ],
  "type": "object",
  "properties": {
    "tppMessages": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/tppMessage2XX"
      }
    },
    "creditorAccount": {
      "$ref": "#/$defs/accountReference"
    },
    "creditorName": {
      "maxLength": 70,
      "minLength": 1,
      "type": "string"
    },
    "debtorAccount": {
      "$ref": "#/$defs/accountReference"
    },
    "instructedAmount": {
      "$ref": "#/$defs/amount"
    },
    "endToEndIdentification": {
      "maxLength": 35,
      "type": [
        "string",
        "null"
      ]
    },
    "creditorAgent": {
      "pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}",
      "type": [
        "string",
        "null"
      ]
    },
    "creditorAddress": {
      "$ref": "#/$defs/address"
    },
    "remittanceInformationUnstructured": {
      "maxLength": 140,
      "type": [
        "string",
        "null"
      ]
    },
    "remittanceInformationStructured": {
      "$ref": "#/$defs/remittanceInformationStructured"
    },
    "debtorAccountMessage": {
      "type": [
        "string",
        "null"
      ]
    },
    "creditorAccountMessage": {
      "type": [
        "string",
        "null"
      ]
    },
    "requestedExecutionDate": {
      "type": [
        "string",
        "null"
      ]
    },
    "transactionStatus": {
      "$ref": "#/$defs/transactionStatus"
    }
  },
  "additionalProperties": false,
  "$defs": {
    "MessageCode2XX": {
      "description": "Message codes for HTTP Error codes 2XX.",
      "type": "string"
    },
    "accountNumber": {
      "description": "Bank account number. Used to identify the particular customer account within the financial institution. \n",
      "type": "string",
      "pattern": "[a-zA-Z0-9]{1,30}"
    },
    "accountReference": {
      "description": "Reference to an account by either\n  * IBAN, of a payment account, or\n  * BBAN, for payment accounts if there is no IBAN, or \n  * the Primary Account Number (PAN) of a card, can be tokenised by the ASPSP due to PCI DSS requirements, or\n  * the Primary Account Number (PAN) of a card in a masked form, or\n  * an alias to access a payment account via a registered mobile phone number (MSISDN).\n",
      "type": "object",
      "properties": {
        "iban": {
          "$ref": "#/$defs/iban"
        },
        "bban": {
          "$ref": "#/$defs/bban"
        },
        "clearingNumber": {
          "$ref": "#/$defs/clearingNumber"
        },
        "accountNumber": {
          "$ref": "#/$defs/accountNumber"
        },
        "pan": {
          "$ref": "#/$defs/pan"
        },
        "maskedPan": {
          "$ref": "#/$defs/maskedPan"
        },
        "msisdn": {
          "$ref": "#/$defs/msisdn"
        },
        "currency": {
          "$ref": "#/$defs/currencyCode"
        }
      }
    },
    "address": {
      "type": "object",
      "required": [
        "country"
      ],
      "properties": {
        "street": {
          "type": "string",
          "maxLength": 70
        },
        "buildingNumber": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "postalCode": {
          "type": "string"
        },
        "country": {
          "$ref": "#/$defs/countryCode"
        }
      }
    },
    "amount": {
      "type": "object",
      "required": [
        "currency",
        "amount"
      ],
      "properties": {
        "currency": {
          "$ref": "#/$defs/currencyCode"
        },
        "amount": {
          "$ref": "#/$defs/amountValue"
        }
      }
    },
    "amountValue": {
      "description": "The amount given with fractional digits, where fractions must be compliant to the currency definition.\nUp to 14 significant figures. Negative amounts are signed by minus.\nThe decimal separator is a dot.\n\n**Example:**\nValid representations for EUR with up to two decimals are:\n\n  * 1056\n  * 5768.2\n  * -1.50\n  * 5877.78\n",
      "type": "string",
      "pattern": "-?[0-9]{1,14}(\\.[0-9]{1,3})?"
    },
    "bban": {
      "description": "Basic Bank Account Number (BBAN) Identifier. Used nationally by financial institutions, i.e., in individual countries, \n  generally as part of a National Account Numbering Scheme(s), \n  which uniquely identifies the account of a customer.\n",
      "type": "string",
      "pattern": "[a-zA-Z0-9]{1,30}"
    },
    "clearingNumber": {
      "description": "Bank account clearing number. Used to identify the financial institution within a domestic payment system. \n",
      "type": "string",
      "pattern": "[0-9]{1,5}"
    },
    "countryCode": {
      "description": "ISO 3166 ALPHA2 country code",
      "type": "string",
      "pattern": "[A-Z]{2}"
    },
    "currencyCode": {
      "description": "ISO 4217 Alpha 3 currency code.\n",
      "type": "string",
      "pattern": "[A-Z]{3}"
    },
    "iban": {
      "type": "string",
      "description": "International Bank Account Number (IBAN) of an account.",
      "pattern": "[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}"
    },
    "maskedPan": {
      "description": "Masked Primary Account Number.\n",
      "type": "string",
      "maxLength": 35
    },
    "msisdn": {
      "type": "string",
      "maxLength": 35,
      "description": "Mobile phone number."
    },
    "pan": {
      "description": "Primary Account Number according to ISO/IEC 7812.\n",
      "type": "string",
      "maxLength": 35
    },
    "remittanceInformationStructured": {
      "description": "Structured remittance information\n",
      "type": "object",
      "required": [
        "reference"
      ],
      "properties": {
        "reference": {
          "type": "string",
          "maxLength": 35
        },
        "referenceType": {
          "type": "string",
          "maxLength": 35
        },
        "referenceIssuer": {
          "type": "string",
          "maxLength": 35
        }
      }
    },
    "tppMessage2XX": {
      "type": "object",
      "required": [
        "category",
        "code"
      ],
      "properties": {
        "category": {
          "$ref": "#/$defs/tppMessageCategory"
        },
        "code": {
          "$ref": "#/$defs/MessageCode2XX"
        },
        "path": {
          "type": "string"
        },
        "text": {
          "$ref": "#/$defs/tppMessageText"
        }
      }
    },
    "tppMessageCategory": {
      "description": "Category of the TPP message category",
      "type": "string",
      "enum": [
        "INFORMATION",
        "UNMAPPED",
        "ERROR",
        "WARNING"
      ]
    },
    "tppMessageText": {
      "description": "Additional explaining text to the TPP.",
      "type": "string",
      "maxLength": 512
    },
    "transactionStatus": {
      "description": "Uses codes from the ISO 20022 data table. See Statuses & Types documentation for full descriptions of values. \n",
      "type": "string",
      "enum": [
        "ACCC",
        "ACCP",
        "ACSC",
        "ACSP",
        "ACTC",
        "ACWC",
        "ACWP",
        "RCVD",
        "PDNG",
        "RJCT",
        "CANC",
        "ACFC",
        "PATC",
        "PART"
      ]
    }
  }
}