Supporting info full JSON schema
Here is the full listing of the supporting information object expressed as a JSON Schema.
Current version
All new implementations should use the current version.
Current JSON schema
This is the current version of the RippleNet Payment Object.
Click to expand v1.1.7
{
"schema": "http://json-schema.org/draft-06/schema#",
"id": "file://po11#",
"title": "RippleNet Payment Object - Supporting Information Schema",
"description": "RippleNet Payment Object - Supporting Information Schema, Version 1.1.7",
"type": "object",
"additionalProperties": false,
"properties": {
"version": {
"type": "string",
"description": "Defines which version of the Payment Object Supporting Information is used",
"maxLength": 10
},
"receiver_version": {
"description": "Specification for the RPO version provided by the Receiving Member.",
"type": "string",
"maxLength": 20
},
"locking_client_id": {
"description": "This is a system populated field.",
"type": "string"
},
"connector_role": {
"description": "This is a system populated field.",
"type": "string"
},
"return_payment": {
"type": "string",
"description": "The `payment_id` of the original payment specified in the request."
},
"return_reasons": {
"type": "array",
"description": "Fields that describe the reason for the return and other metadata related to the return. These are the same fields specified in the request.",
"items": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Failure types that Members provide, according to the standards for Member-initiated exceptions. For more information about business exceptions, [Returns and failure codes](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/error-codes/returns-and-error-codes/#811-failure-types-and-return-reason-types).",
"enum": [
"RECEIVER_DATA_VALIDATION",
"RECEIVER_LOCK_FAILURE",
"SENDER_PROCESSING_FAILURE",
"RECEIVER_PROCESSING_ERROR",
"BENEFICIARY_RETURN",
"SENDER_RETURN"
],
"x-enumDescriptions": {
"RECEIVER_DATA_VALIDATION": "Failures initiated by the Receiving Member based on the validation of the payment data",
"RECEIVER_LOCK_FAILURE": "General failure based on receiver processing prior to locking the payment and subsequent settlement",
"SENDER_PROCESSING_FAILURE": "General failure based on sender processing prior to initiating settlement",
"RECEIVER_PROCESSING_ERROR": "General failure based on the receiver processing the payment to the Beneficiary after settlement is complete.<br/><br/>Also used as the return reason type when the associated return is processed by the Receiving Member",
"BENEFICIARY_RETURN": "Returns performed based on a request from the Beneficiary",
"SENDER_RETURN": "Returns performed based on a request from the Originator"
}
},
"code": {
"type": "string",
"description": "Per the business exceptions defined in [Chapter 4, Section 4.2](https://docs.ripple.com/payments-odl/rulebook/), ISO 20022 status reasons (specifically, those defined in [External Codeset 16](https://www.iso20022.org/external_code_list.page) are used as the failure codes and reason text.<br/><br/><b>Note</b>: <ul><li>Using codes outside these standards will result in partner compatibility issues. You can request additional codes through the change request process.</li><li>For more information about individual code details, see [ExternalCodeSets2Q2020May2020_v1.xls](https://www.iso20022.org/sites/default/files/2020-05/ExternalCodeSets_2Q2020_May2020_v1.xls).</li></ul>",
"enum": [
"AC01",
"AC02",
"AC03",
"AC04",
"AC06",
"AC08",
"AC09",
"AC10",
"AC11",
"AC12",
"AC13",
"AC14",
"AC15",
"AC16",
"AG01",
"AG02",
"AG03",
"AG05",
"AG06",
"AG12",
"AG13",
"AM01",
"AM02",
"AM03",
"AM04",
"AM05",
"AM07",
"AM09",
"AM11",
"AM13",
"AM14",
"AM15",
"AM21",
"AM22",
"BE01",
"BE04",
"BE05",
"BE06",
"BE07",
"BE08",
"BE09",
"BE10",
"BE11",
"BE12",
"BE13",
"BE14",
"BE15",
"BE16",
"BE17",
"BE18",
"BE19",
"BE20",
"BE21",
"BE22",
"BE23",
"CERI",
"CH11",
"CH12",
"CH13",
"CH14",
"CH15",
"CH16",
"CH17",
"CH20",
"CH21",
"CNOR",
"CURR",
"CUST",
"DS24",
"DS25",
"DNOR",
"DU01",
"DU02",
"DU03",
"DU04",
"DU05",
"DUPL",
"ED06",
"FF03",
"FF04",
"FF05",
"FF06",
"FF07",
"FF08",
"FF10",
"G000",
"G001",
"MD06",
"MD07",
"MS02",
"MS03",
"NARR",
"RB001",
"RB002",
"RB003",
"RB004",
"RB005",
"RB006",
"RB007",
"RB008",
"RB009",
"RB010",
"RB011",
"RB012",
"RB013",
"RB014",
"RB015",
"RB016",
"RB017",
"RB018",
"RB019",
"RB020",
"RB021",
"RB022",
"RB023",
"RB024",
"RB025",
"RB026",
"RB027",
"RB028",
"RB029",
"RB030",
"RB031",
"RB032",
"RB033",
"RB034",
"RB035",
"RB036",
"RB037",
"RB038",
"RB039",
"RB040",
"RB041",
"RB042",
"RB043",
"RB044",
"RB045",
"RB046",
"RB047",
"RB048",
"RB049",
"RB050",
"RB051",
"RB052",
"RB053",
"RB054",
"RB055",
"RB056",
"RB057",
"RB058",
"RB059",
"RB060",
"RB061",
"RB062",
"RB063",
"RB064",
"RB065",
"RB066",
"RB067",
"RB068",
"RB069",
"RB070",
"RC01",
"RC02",
"RC03",
"RC04",
"RC05",
"RC06",
"RC07",
"RC08",
"RC09",
"RC10",
"RC12",
"RECI",
"RF01",
"RR01",
"RR02",
"RR03",
"RR04",
"RR05",
"RR06",
"RR07",
"RR10",
"SL03",
"TK01",
"TK02",
"TK03",
"TK09",
"TKCM",
"TKSG",
"TKSP",
"TKVE",
"TKXP"
],
"x-enumDescriptions": {
"AC01": "Account number is invalid or missing.",
"AC02": "Debtor account number invalid or missing.<br/><br/><b>Error handling</b><br/>If the account number or IBAN is invalid, the Sending Member may repair the transaction by specifying a valid Originator account number.<br /><br />If the account number is missing from the payment message, the Originator may reissue the payment with the Originator account number or IBAN included.",
"AC03": "Creditor account number invalid or missing.<br/><br/><b>Error handling</b><br/>If the account number or IBAN is invalid, the Sending Member may repair the transaction by specifying a valid Creditor account number.<br /><br />If the account number is missing from the payment message, the Originator may reissue the payment with the Creditor account number or IBAN included.",
"AC04": "Account number specified has been closed on the Receiver's books.<br />The Beneficiary may have closed their account since the last time the Originator made a payment transfer to this Beneficiary.<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary for their new account number.",
"AC06": "Account specified is blocked, prohibiting posting of transactions against it. <br />The Account Servicer may have frozen the account for legal reasons, or on the Beneficiary's request.<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary for alternative account details.",
"AC08": "Branch code is invalid or missing.<br/><br/><b>Error handling</b><br/>If the branch code is invalid, the Sending Member may repair the transaction by specifying the complete branch code.<br /><br />If the branch code is missing, the Originator may reissue the payment with the correct branch code included.",
"AC09": "Account currency is invalid or missing.<br /> This error is likely caused by a technical or human error. This error may also occur if the Beneficiary provided incorrect information to the Originator.<br/><br/><b>Error handling</b><br/>In case of a technical or human error, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not specify invalid account currency information. <br /><br />If the Beneficiary provided incorrect account information, the Originator may contact the Beneficiary for accurate information.",
"AC10": "Debtor account currency is invalid or missing.<br/><br/><b>Error handling</b><br/>If the account currency information is invalid, the Sending Member may repair the transaction by specifying a valid Originator account currency.<br /> <br />If the account currency information is missing, the Originator may reissue the payment with the Originator account currency specified.",
"AC11": "Creditor account currency is invalid or missing.<br/><br/><b>Error handling</b><br/>If the account currency information is invalid, the Sending Member may repair the transaction by specifying a valid Beneficiary account currency.<br /><br /> If the account currency information is missing, the Originator may reissue the payment with the Beneficiary account currency specified.",
"AC12": "Account type missing or invalid. Generic usage if cannot specify between group and payment information levels.",
"AC13": "Debtor account type missing or invalid.<br/><br/><b>Error handling</b><br/>If the account type information is invalid, the Sending Member may repair the transaction by specifying the correct Originator account type.<br /><br /> If the account type information is missing, the Originator may reissue the payment with the Originator account type specified.",
"AC14": "Creditor account type missing or invalid.<br/><br/><b>Error handling</b><br/>If the account type information is invalid, the Sending Member may repair the transaction by specifying the correct Beneficiary account type.<br /><br /> If the account type information is missing, the Originator may reissue the payment with the Beneficiary account type specified.",
"AC15": "The account details for the counterparty have changed.",
"AC16": "Credit or debit card number is invalid.",
"AG01": "Transaction forbidden on this type of account (formerly NoAgreement).<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary for details of an alternative account that can receive the transaction.",
"AG02": "Bank Operation code specified in the message is not valid for receiver.<br/><br/><b>Error handling</b><br/>If the bank code information is invalid, the Sending Member may repair the transaction by specifying the correct code.<br /><br /> If the bank code information is missing, the Originator may reissue the payment with the bank code specified.",
"AG03": "Transaction type not supported/authorized on this account.<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary to agree on a different payment instrument.",
"AG05": "Debtor agent country code is missing or invalid.<br/><br/><b>Error handling</b><br/>If the country code information is invalid, the Sending Member may repair the transaction by specifying the correct Sender Agent country code.<br /><br /> If the country code information is missing, the Originator may reissue the payment with the Sender Agent country code specified.",
"AG06": "Creditor agent country code is missing or invalid.<br/><br/><b>Error handling</b><br/>If the country code information is invalid, the Sending Member may repair the transaction by specifying the correct Beneficiary Agent country code.<br /><br /> If the country code information is missing, the Originator may reissue the payment with the Beneficiary Agent country code specified.",
"AG12": "Payment orders made by transferring funds from one account to another at the same financial institution (bank or payment institution) are not allowed.",
"AG13": "Returned payments derived from previously returned transactions are not allowed.",
"AM01": "Specified message amount is equal to zero.",
"AM02": "Specific transaction/message amount is greater than allowed maximum.<br/><br/><b>Error handling</b><br/>The Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not transfer incorrect amounts.",
"AM03": "Specified message amount is a non-processable currency outside of existing agreement.<br/><br/><b>Error handling</b><br/>The Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not initiate payments in unsupported currency.",
"AM04": "Amount of funds available to cover specified message amount is insufficient. <br /><br />This error may occur due to the following reasons:<ul><li>The Originator's account does not have sufficient funds to debit the full amount of the payment.</li><li>There are insufficient funds in the Sending/Originating Bank's nostro settlement account at the Local Clearing/Receiver/Beneficiary bank to process the payment. </li></ul><br/><br/><b>Error handling</b><br/>If the Originator's account previously had insufficient funds, the Sending Member may reissue the payment after the Originator ensures that their account contains the funds required to process the payment.<br /><br />If the Sending/Originating Bank's nostro settlement account previously had insufficient funds, they can reissue the payment after ensuring that their settlement account contains sufficient funds to process the payment.",
"AM05": "Duplication",
"AM07": "Amount specified in message has been blocked by regulatory authorities.",
"AM09": "Amount received is not the amount agreed or expected.<br/><br/><b>Error handling</b><br/>The Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not transfer incorrect amounts.",
"AM11": "Transaction currency information is invalid or missing.",
"AM13": "Transaction amount exceeds limits set by clearing system.<br/><br/><b>Error handling</b><br/>The Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not transfer incorrect amounts.",
"AM14": "Transaction amount exceeds limits agreed between bank and client.<br/><br/><b>Error handling</b><br/>The Beneficiary may request the Originator to initiate a payment whose transaction amount is within the agreed limits. Further, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not transfer incorrect amounts.",
"AM15": "Transaction amount below minimum set by clearing system.<br/><br/><b>Error handling</b><br/>The Beneficiary may request the Originator to initiate a payment whose transaction amount is within the agreed limits. Further, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not transfer incorrect amounts.",
"AM21": "Transaction amount exceeds limits agreed between bank and client.",
"AM22": "Unable to apply zero amount to designated account. For example, where the rules of a service allow the use of zero amount payments, however the back-office system is unable to apply the funds to the account. If the rules of a service prohibit the use of zero amount payments, then code AM01 is used to report the error condition.",
"BE01": "Identification of end customer is not consistent with associated account number (formerly CreditorConsistency). <br />This error typically occurs because the Originator entered an incorrect Beneficiary account number while initiating the payment.<br/><br/><b>Error handling</b><br/>The Sending Member may introduce additional prompts in the user interface during payment initiation to ensure that the Originator verifies the Beneficiary's account number.",
"BE04": "Specification of creditor's address, which is required for payment, is missing/not correct (formerly IncorrectCreditorAddress).<br/><br/><b>Error handling</b><br/>If the Beneficiary address is invalid, the Sending Member may repair the transaction by providing the correct Beneficiary address. <br /><br />If the Beneficiary address is missing, the Originator may reissue the payment with the Beneficiary address specified.",
"BE05": "Party who initiated the message is not recognized by the end customer.",
"BE06": "End customer specified is not known at associated Sort/National Bank Code or does no longer exist in the books.",
"BE07": "Specification of debtor's address, which is required for payment, is missing/not correct.<br/><br/><b>Error handling</b><br/>If the Originator's address is invalid, the Sending Member may repair the transaction by providing the correct Originator address. <br /><br /> If the Originator's address is missing, the Originator may reissue the payment with their address specified.",
"BE08": "Debtor name is missing.<br/><br/><b>Error handling</b><br/>If the Originator's name is invalid, the Sending Member may repair the transaction by providing the correct Originator name. <br /><br /> If the Originator's name is missing, the Originator may reissue the payment with their name specified.",
"BE09": "Country code is missing or Invalid. Generic usage if cannot specifically identify debtor or creditor.",
"BE10": "Debtor country code is missing or invalid.<br/><br/><b>Error handling</b><br/>If the Originator's country code is invalid, the Sending Member may repair the transaction by providing the correct Originator country code. <br /><br /> If the Originator's country code is missing, the Originator may reissue the payment with the country code specified.",
"BE11": "Creditor country code is missing or invalid.<br/><br/><b>Error handling</b><br/>If the Beneficiary's country code is invalid, the Sending Member may repair the transaction by providing the correct Beneficiary country code. <br /><br /> If the Beneficiary's country code is missing, the Originator may reissue the payment with the Beneficiary country code specified.",
"BE12": "Country code of residence is missing or Invalid. This generic error code should be used only if the relevant party is not clearly identifiable or specified.",
"BE13": "Country code of debtor's residence is missing or Invalid.<br/><br/><b>Error handling</b><br/>If the country code for Originator's country of residence is invalid, the Sending Member may repair the transaction by providing the correct country code.<br /><br /> If the country code for Originator's country of residence is missing, the Originator may reissue the payment with the country code specified.",
"BE14": "Country code of creditor's residence is missing or Invalid.<br/><br/><b>Error handling</b><br/>If the country code for Beneficiary's country of residence is invalid, the Sending Member may repair the transaction by providing the correct country code.<br /><br /> If the country code for Beneficiary's country of residence is missing, the Originator may reissue the payment with the Beneficiary country code specified.",
"BE15": "Identification code missing or invalid. Generic usage if cannot specifically identify debtor or creditor.",
"BE16": "Debtor or Ultimate Debtor identification code missing or invalid.<br/><br/><b>Error handling</b><br/>If the Originator's identification code is invalid, the Sending Member may repair the transaction by providing the correct identification code. <br /><br />If the Originator's identification code is missing, the Originator may reissue the payment with the identification code specified.",
"BE17": "Creditor or Ultimate Creditor identification code missing or invalid.<br/><br/><b>Error handling</b><br/>If the Beneficiary's identification code is invalid, the Sending Member may repair the transaction by providing the correct identification code. <br /><br />If the Beneficiary's identification code is missing, the Originator may reissue the payment with the Beneficiary identification code specified.",
"BE18": "Contact details missing or invalid.<br/><br/><b>Error handling</b><br/>If the contact details are invalid, the Sending Member may repair the transaction by providing the correct contact details.<br /><br /> If the contact details are missing, the Originator may reissue the payment with the contact details specified.",
"BE19": "Charge bearer code for transaction type is invalid.<br/><br/><b>Error handling</b><br/>If the charge bearer code is invalid, the Sending Member may repair the transaction by providing the correct charge bearer code.<br /><br /> If the charge bearer code is missing, the Originator may reissue the payment with the charge bearer code specified.",
"BE20": "Name length exceeds local rules for payment type.",
"BE21": "Name missing or invalid. Generic usage if cannot specifically identify debtor or creditor.",
"BE22": "Creditor name is missing.<br/><br/><b>Error handling</b><br/>If the Beneficiary's name is invalid, the Sending Member may repair the transaction by providing the correct Beneficiary name. <br /><br />If the Beneficiary's name is missing, the Originator may reissue the payment with the Beneficiary's name specified.",
"BE23": "Phone number or email address, or any other proxy, used as the account proxy is unknown or invalid.",
"CERI": "Credit transfer is not tagged as an Extended Remittance Information (ERI) transaction but contains ERI.",
"CH11": "Value in Creditor Identifier is incorrect.",
"CH12": "Creditor Identifier is ambiguous at Transaction Level.",
"CH13": "Original Debtor Account is not to be used.",
"CH14": "Original Debtor Agent is not to be used.",
"CH15": "Content Remittance Information/Structured includes more than 140 characters.",
"CH16": "Content is incorrect.",
"CH17": "Element is not allowed.",
"CH20": "Number of decimal points not compatible with the currency.",
"CH21": "Mandatory element is missing.",
"CNOR": "Creditor bank is not registered under this BIC in the CSM.",
"CURR": "Currency of the payment is incorrect.",
"CUST": "Cancellation requested by the Debtor.",
"DS24": "Waiting time expired due to incomplete order.<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary and ask them to take the actions necessary to receive funds. <br /><br />If the payment is resubmitted, a new reference ID must be used.",
"DS25": "The order file was deleted by the bank server (for multiple reasons).",
"DNOR": "Debtor bank is not registered under this BIC in the CSM.",
"DU01": "Message Identification is not unique. <br /><br />This error typically occurs when the Sending Member submits a transaction with a message ID that matches a previous transaction's message ID.<br/><br/><b>Error handling</b><br/>The Sending Member must resubmit the transaction with a unique message ID. <br /><br />The following measures may also be considered:<ul><li>Sending and Receiving Members agree on the criteria to identify duplicate payments, and the window within which Intermediaries or Receiving Members will check for duplicate payments.</li><li>The Sending Member may implement checks to avoid submitting duplicate payments.</li><li>If a duplicate payment occurs, the Sending Member may resubmit the payment with new reference information within the duplication window. If the window expires, the Sending Member may initiate a new payment.</li></ul>",
"DU02": "Payment Information Block is not unique.",
"DU03": "Transaction is not unique.",
"DU04": "End To End ID is not unique. <br /><br />This error typically occurs when the Sending Member submits a transaction with an end-to-end ID that matches a previous transaction's end-to-end ID.<br/><br/><b>Error handling</b><br/>The Sending Member must resubmit the transaction with a unique end-to-end ID. <br /><br />The following measures may also be considered:<ul><li>Sending and Receiving Members agree on the criteria to identify duplicate payments, and the window within which Intermediaries or Receiving Members will check for duplicate payments.</li><li>The Sending Member may implement checks to avoid submitting duplicate payments.</li><li>If a duplicate payment occurs, the Sending Member may resubmit the payment with new reference information within the duplication window. If the window expires, the Sending Member may initiate a new payment.</li></ul>",
"DU05": "Instruction ID is not unique. <br /><br />This error typically occurs when the Sending Member submits a transaction with an Instruction ID that matches a previous transaction's Instruction ID.<br/><br/><b>Error handling</b><br/>The Sending Member must resubmit the transaction with a unique Instruction ID. <br /><br />The following measures may also be considered:<ul><li>Sending and Receiving Members agree on the criteria to identify duplicate payments, and the window within which Intermediaries or Receiving Members will check for duplicate payments.</li><li>The Sending Member may implement checks to avoid submitting duplicate payments.</li><li>If a duplicate payment occurs, the Sending Member may resubmit the payment with new reference information within the duplication window. If the window expires, the Sending Member may initiate a new payment.</li></ul>",
"DUPL": "Payment is a duplicate of another payment. <br /><br />This error typically occurs when the Sending Member submits a transaction with reference information that matches a previous transaction's reference information.<br/><br/><b>Error handling</b><br/>The Sending Member must resubmit the transaction with unique reference information. <br /><br />The following measures may also be considered:<ul><li>Sending and Receiving Members agree on the criteria to identify duplicate payments, and the window within which Intermediaries or Receiving Members will check for duplicate payments.</li><li>The Sending Member may implement checks to avoid submitting duplicate payments.</li><li>If a duplicate payment occurs, the Sending Member may resubmit the payment with new reference information within the duplication window. If the window expires, the Sending Member may initiate a new payment.</li></ul>",
"ED06": "Interbank settlement system not available. <br /><br />This error typically occurs when the connecting infrastructure of the local clearing rail at the Receiving Member is unavailable to process or transmit any payment messages.<br/><br/><b>Error handling</b><br/>The Sending Member may recommend that the Originator reissue the RippleNet payment at a later time.<br /><br />The Originator may contact the Beneficiary to determine an alternative solution to make the payment.",
"FF03": "Payment Type Information is missing or invalid. This generic error code should be used only if Service Level or Local Instrument code are not specified.<br/><br/><b>Error handling</b><br/>If the payment type information is invalid, the Sending Member may repair the transaction by providing the correct payment type information.<br /><br />If the payment type information is missing, the Originator may reissue the payment with the payment type information specified.",
"FF04": "Service Level code is missing or invalid.<br/><br/><b>Error handling</b><br/>If the service level code is invalid, the Sending Member may repair the transaction by providing the correct code.<br /><br />If the service level code is missing, the Originator may reissue the payment with the code specified.",
"FF05": "Local Instrument code is missing or invalid.<br/><br/><b>Error handling</b><br/>If the local instrument code is invalid, the Sending Member may repair the transaction by providing the correct code.<br /><br />If the local instrument code is missing, the Originator may reissue the payment with the code specified.",
"FF06": "Category Purpose code is missing or invalid.<br/><br/><b>Error handling</b><br/>If the category purpose code is invalid, the Sending Member may repair the transaction by providing the correct code.<br /><br />If the category purpose code is missing, the Originator may reissue the payment with the code specified.",
"FF07": "Purpose of payment is missing or invalid.<br/><br/><b>Error handling</b><br/>If the purpose of payment information is invalid, the Sending Member may repair the transaction by providing the correct information.<br /><br />If the purpose of payment information is missing, the Originator may reissue the payment with the purpose of payment specified.",
"FF08": "End to End Id missing or invalid.<br/><br/><b>Error handling</b><br/>If the end-to-end ID is invalid, the Sending Member may repair the transaction by providing the correct ID. <br /><br /> If the end-to-end ID is missing, the Originator may reissue the payment with the ID specified.",
"FF10": "File or transaction cannot be processed due to technical issues at the bank side.<br/><br/><b>Error handling</b><br/>The Sending Member may recommend that the Originator reissue the RippleNet payment at a later time.<br /><br />The Originator may contact the Beneficiary to determine an alternative solution to make the payment.",
"G000": "The payment transfer is tracked. No further updates will follow from the Status Originator.",
"G001": "PaymentTransferredAndNotTracked<br/><br/><b>Error handling</b><br/>The payment transfer is tracked. No further updates will follow from the Status Originator.",
"MD06": "Return of funds requested by end customer.",
"MD07": "End customer is deceased.",
"MS02": "Reason has not been specified by end customer.",
"MS03": "Reason has not been specified by agent.",
"NARR": "Reason is provided as narrative information in the additional reason information.",
"RB001": "The account number structure is valid but the account number does not correspond to the individual identified in the payment. <br /><br />This error typically occurs because the Originator specified the Beneficiary's account number incorrectly while initiating the payment.<br/><br/><b>Error handling</b><br/>The Sending Member may introduce prompts in the user interface during payment initiation to ensure that the Originator validates the Beneficiary's account number.",
"RB002": "The Sender has requested Receiver for return of the payment.<br /><br />This error typically occurs in business scenarios where the Originator contacts the Sending Member to indicate that they (the Originator) provided incorrect account information.<br/><br/><b>Error handling</b><br/>The Sending Member must contact the Receiving Member and obtain agreement that the payment should be returned. After obtaining agreement, the Receiving Member can initiate the return of the payment.",
"RB003": "The funds for the payment have not been collected by the Beneficiary within the set period.<br/><br/><b>Error handling</b><br/>The Originator must inform the Beneficiary that they should collect the funds within the prescribed time frame. <br /><br />The Receiving Member may also contact the Beneficiary to inform them of pending or uncollected funds. <br />Further, the Receiving Member must ensure that the Sending Member includes the Beneficiary's contact information in the RippleNet Payment Object.",
"RB004": "Beneficiary's account is frozen due to specific action taken by the Receiver or by legal action. <br /><br /> This error typically occurs when the Beneficiary's bank has frozen the account due to suspected misuse, or on the Beneficiary's request.<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary for alternative account information or to agree on an alternative payment mechanism.",
"RB005": "The Receiver has returned the payment due to one of the following reasons: <br /><br /><ul><li>The exact amount required has not been remitted. </li><li>Acceptance of the transaction results in an overpayment.</li></ul><br/><br/><b>Error handling</b><br/>In case of a technical or human error, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not transfer the incorrect amount. <br /><br />The Beneficiary may contact the Originator and ask them to initiate a payment for the exact amount.",
"RB006": "The return payment has not been sent within the agreed timeframe. <br /><br />This error typically occurs when the sender of the original payment has declined the return payment because it was not sent within the agreed upon timeframe for return payments.<br/><br/><b>Error handling</b><br/>The member making the return payment may take measures to ensure that the return payment is initiated within the timeframe that the Sending and Receiving Members have agreed upon.",
"RB007": "The sender of the original payment has not agreed to accept the return payment or has not requested the return payment.<br /><br />This error typically occurs when the sender of the original payment declines the return payment for business or other reasons.<br/><br/><b>Error handling</b><br/>The Beneficiary Bank or the Receiving Member may contact the Originator's Bank or the Sending Member to enquire about the reason for the return payment. <br /><br />If required, the member making the return payment may request alternative mechanisms for returning the payment, or resubmit the return payment.",
"RB008": "Invalid account title or name prefix. <br /><br />This error typically occurs when the Beneficiary's title or name specified in the payment does not match the information associated with their account.<br/><br/><b>Error handling</b><br/>In case of a technical or human error, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not provide the incorrect Beneficiary title or name. <br /><br />If the Beneficiary provided incorrect information, the Originator may contact the Beneficiary to obtain the correct information.",
"RB009": "Beneficiary's account is dormant. <br /><br />This error typically occurs because the Beneficiary's Bank has marked the account as dormant due to a lack of activity or financial transactions on the account.<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary for alternative account information or to agree upon a different payment mechanism.",
"RB010": "The minimum amount required has not been remitted. <br /><br />This error typically occurs because the Originator has initiated payment for an amount that is lower than the intended amount that they previously agreed upon with the Beneficiary.<br/><br/><b>Error handling</b><br/>In case of technical or human error, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not specify incorrect amounts.",
"RB011": "The account is subject to litigation. <br /><br />This error typically occurs because the Beneficiary's Bank has frozen the account due to legal reasons, or under suspicion of misuse, or on the Beneficiary's request.<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary for alternative account information or to agree upon a different payment mechanism.",
"RB012": "The Originator is not known to the Recipient or Beneficiary.<br/><br/><b>Error handling</b><br/>In case of technical or human error, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not initiate payments to unknown or unintended Beneficiary accounts.",
"RB013": "The Receiver has not authorized this credit entry to the Beneficiary's account. <br /><br />This error typically occurs because the Beneficiary's Bank has blocked the account due to legal reasons.<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary for alternative account information or to agree upon a different payment mechanism.",
"RB014": "Amount specified in the payment has been blocked by regulatory authorities. <br /><br />This error typically occurs when the amount specified in the payment has been blocked or seized by regulatory authorities due to anti-money laundering or compliance reasons.<br/><br/><b>Error handling</b><br/>The Originator may contact the Sending Member for more information.",
"RB015": "The payment is a suspicious payment. <br /><br />This error typically occurs when the payment screening rules or policies of the Receiving Member or the Beneficiary Bank flag the payment as a suspicious payment.<br/><br/><b>Error handling</b><br/>The Sending Member may work with the Receiving Member to support resolution of the issue.",
"RB016": "Know Your Customer (KYC) pending for the individual identified in the payment. <br /><br /> This error typically occurs because the payment cannot be booked to the Beneficiary's account due to pending KYC.<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary to agree upon a different payment mechanism.",
"RB017": "Government or National ID of the individual identified in the payment is not mapped to the account number. <br /><br />This error typically occurs when the payment cannot be booked to the Beneficiary's account because their Government or National ID is not linked with their account.<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary to agree upon a different payment mechanism.",
"RB018": "Customer insolvent or other reason.",
"RB019": "Return amount does not match with original payment amount.<br /><br /><br />This error typically occurs because the Receiving Member initiated return of an amount less than the original payment amount. This may occur because the Receiving Member deducted fees for the return.<br/><br/><b>Error handling</b><br/>The Receiving Member must return the amount per their bilateral agreement with the Sending Member.",
"RB020": "Return information does not match with the original payment information.<br/><br/><b>Error handling</b><br/>The Receiving Member must pass the required information with the return payment per their agreement with the Sending Member.",
"RB021": "Return or refund amount must be greater than zero. <br /><br />This error occurs because RippleNet does not allow return amounts less than zero.",
"RB022": "Return or refund amount must be less than the maximum limit. <br /><br />This error occurs because RippleNet does not allow the return amount to exceed the original payment amount.",
"RB023": "Beneficiary account name does not match Beneficiary account number.<br/><br/><b>Error handling</b><br/>In case of technical or human error, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not specify incorrect Beneficiary name.<br /><br /> If the account name was invalid, the Originator may contact the Beneficiary for correct information.",
"RB024": "Account is not in currency quoted.<br/><br/><b>Error handling</b><br/>In case of technical or human error, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not specify incorrect account currency information.<br /><br /> The Originator may request the Beneficiary to provide accurate information about their account currency.",
"RB025": "Originator account number closed.<br/><br/><b>Error handling</b><br/>The Originator may provide alternative account information.",
"RB026": "Beneficiary account number closed.<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary for alternative account information.",
"RB027": "Beneficiary does not support or accept this message or payment type.<br/><br/><b>Error handling</b><br/>In case of technical or human error, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not specify the wrong payment type.<br /><br />The Beneficiary may request the Originator to re-initiate the payment with a supported payment type.",
"RB028": "Payment was not processed as Receiver is unavailable or offline. <br /><br />This error typically occurs when the RippleNet connection to and from the Receiving Member or Intermediary Bank is unavailable due to network issues.<br/><br/><b>Error handling</b><br/>The Sending Member may request the Originator to reissue the RippleNet payment at a later time.",
"RB029": "Invalid payment type. The payment type used is not allowed or enabled for this Bank.<br/><br/><b>Error handling</b><br/>In case of technical or human error, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not specify the wrong payment type.<br /><br />The Beneficiary may request the Originator to re-initiate the payment with a valid payment type.",
"RB030": "Card is blocked, or lost, or hotlisted. <br /><br /> This error typically occurs if the Beneficiary Bank has blocked the card account due to reported theft or other legal issues.<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary for alternative account details.",
"RB031": "Card is expired.<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary for alternative account details.",
"RB032": "Invalid card number. <br /><br />This error typically occurs either because the Originator entered an invalid card number while initiating the payment, or because the Beneficiary provided an invalid card number to the Originator.<br/><br/><b>Error handling</b><br/>In case of a technical or human error, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not supply an invalid or incomplete card number. <br /><br />If the Beneficiary provided an incorrect card number, the Originator may contact the Beneficiary for the correct number.",
"RB033": "Transactions to the card are restricted. <br /><br /> This error typically occurs because the Beneficiary Bank has restricted financial transactions on the card due to legal reasons or reports of fraudulent usage.<br/><br/><b>Error handling</b><br/>The Originator may request the Beneficiary to provide alternative account information.",
"RB034": "Beneficiary has exceeded the number of transactions allowed for a set time period. <br /><br /> This error typically occurs due to failed velocity or fraud checks conducted by the Receiving Member.",
"RB035": "Beneficiary has exceeded the cumulative transaction amount allowed for a set time period. <br /><br /> This error typically occurs due to failed velocity or fraud checks conducted by the Receiving Member.",
"RB036": "Originator has exceeded the number of transactions allowed for a set time period. <br /><br /> This error typically occurs due to failed velocity or fraud checks conducted by the Receiving Member.",
"RB037": "Originator has exceeded the cumulative transaction amount allowed for a set time period. <br /><br /> This error typically occurs due to failed velocity or fraud checks conducted by the Receiving Member.",
"RB038": "Beneficiary nationality is invalid.<br/><br/><b>Error handling</b><br/>If the Beneficiary nationality information is invalid, the Sending Member may repair the transaction by providing the correct information. <br /><br />If the Beneficiary nationality information is missing, the Originator may reissue the payment with the information specified.",
"RB039": "Beneficiary nationality is missing in the payment message.<br/><br/><b>Error handling</b><br/>If the provided Beneficiary nationality information is incomplete, the Sending Member may repair the transaction by completing the information. <br /><br />If the Beneficiary nationality information is missing, the Originator may reissue the payment with the information specified.",
"RB040": "Originator nationality is invalid.<br/><br/><b>Error handling</b><br/>If the Originator nationality information is invalid, the Sending Member may repair the transaction by providing the correct information. <br /><br />If the Originator nationality information is missing, the Originator may reissue the payment with the information specified.",
"RB041": "Originator nationality is missing in the payment message.<br/><br/><b>Error handling</b><br/>If the provided Originator nationality information is incomplete, the Sending Member may repair the transaction by completing the information. <br /><br />If the Originator nationality information is missing, the Originator may reissue the payment with the information specified.",
"RB042": "Wallet identifier is invalid. <br /><br />This error typically occurs because the Beneficiary provided invalid wallet information. It may also occur because the Originator specified incorrect Beneficiary wallet information while initiating the payment.<br/><br/><b>Error handling</b><br/>The Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not specify incorrect Beneficiary wallet identifier.",
"RB043": "Transaction amount will make the wallet balance exceed the allowed limit.<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary to agree upon a different payment mechanism. <br /><br />Alternatively, the Originator may contact the Beneficiary to confirm the maximum allowed wallet balance and then issue a payment that will not cause the Beneficiary's wallet balance to exceed the limit.",
"RB044": "Transactions to wallet are stopped or not allowed. <br /><br /> This error typically occurs because the wallet servicer has restricted financial transactions on the wallet due to legal reasons or suspicious use.<br/><br/><b>Error handling</b><br/>The Originator may contact the Beneficiary to obtain alternative account information or agree upon a different payment mechanism.",
"RB045": "The relationship to debtor details are missing.",
"RB046": "The relationship to debtor details are invalid.",
"RB047": "The relationship to creditor details are missing.",
"RB048": "The relationship to creditor details are invalid.",
"RB049": "The date of issuance for the id provided for the Creditor is missing.",
"RB050": "The date of issuance for the id provided for the Creditor is invalid.",
"RB051": "The date of issuance for the id provided for the Creditor is in the future.",
"RB052": "The date of expiry for the id provided for the Creditor is missing.",
"RB053": "The date of expiry for the id provided for the Creditor is invalid.",
"RB054": "The date of expiry for the id provided for the Creditor has passed.",
"RB055": "The date of incorporation for the Creditor is missing.",
"RB056": "The date of incorporation for the Creditor is invalid.",
"RB057": "The date of incorporation for the Creditor is in the future.",
"RB058": "The country of incorporation for the Creditor is missing.",
"RB059": "The country of incorporation for the Creditor is invalid.",
"RB060": "The date of issuance for the id provided for the Debtor is missing.",
"RB061": "The date of issuance for the id provided for the Debtor is invalid.",
"RB062": "The date of issuance for the id provided for the Debtor is in the future.",
"RB063": "The date of expiry for the id provided for the Debtor is missing.",
"RB064": "The date of expiry for the id provided for the Debtor is invalid.",
"RB065": "The date of expiry for the id provided for the Debtor has passed.",
"RB066": "The date of incorporation for the Debtor is missing.",
"RB067": "The date of incorporation for the Debtor is invalid.",
"RB068": "The date of incorporation for the Debtor is in the future.",
"RB069": "The country of incorporation for the Debtor is missing.",
"RB070": "The country of incorporation for the Debtor is invalid.",
"RC01": "Bank identifier code specified in the message has an incorrect format (formerly IncorrectFormatForRoutingCode).",
"RC02": "Bank identifier is invalid or missing. Generic usage if cannot specify between debit or credit account.",
"RC03": "Debtor bank identifier is invalid or missing.<br/><br/><b>Error handling</b><br/>If the Debtor Bank identifier is invalid, the Originator Bank may repair the transaction by providing the correct identifier. <br /><br />If the Debtor Bank identifier is missing, the Originator may reissue the payment with the identifier specified.",
"RC04": "Creditor bank identifier is invalid or missing.<br/><br/><b>Error handling</b><br/>If the Creditor Bank identifier is invalid, the Sending Member may repair the transaction by providing the correct identifier. <br /><br />If the Creditor Bank identifier is missing, the Originator may reissue the payment with the identifier specified.",
"RC05": "BIC identifier is invalid or missing. This generic error code should be used only if the relevant party is not clearly identifiable or specified.<br/><br/><b>Error handling</b><br/>If the BIC is invalid, the Sending Member may repair the transaction by providing the correct identifier. <br /><br />If the BIC is missing, the Originator may reissue the payment with the BIC identifier specified.",
"RC06": "Debtor BIC identifier is invalid or missing.<br/><br/><b>Error handling</b><br/>If the Debtor Bank BIC is invalid, the Sending Member may repair the transaction by providing the correct identifier. <br /><br />If the Debtor Bank BIC is missing, the Originator may reissue the payment with the identifier specified.",
"RC07": "Creditor BIC identifier is invalid or missing.<br/><br/><b>Error handling</b><br/>If the Beneficiary's BIC identifier is invalid, the Sending Member may repair the transaction by providing the correct BIC identifier.<br /><br /> If the Beneficiary's BIC identifier is missing, the Originator may reissue the payment with the BIC identifier specified.",
"RC08": "ClearingSystemMember identifier is invalid or missing. Generic usage if cannot specify between debit or credit account.",
"RC09": "Debtor ClearingSystemMember identifier is invalid or missing.<br/><br/><b>Error handling</b><br/>If the Originator's ClearingSystemMember identifier is invalid, the Sending Member may repair the transaction by providing the correct identifier. <br /><br />If the Originator's ClearingSystemMember identifier is missing, the Originator may reissue the payment with the identifier specified.",
"RC10": "Creditor ClearingSystemMember identifier is invalid or missing.<br/><br/><b>Error handling</b><br/>If the Beneficiary's ClearingSystemMember identifier is invalid, the Sending Member may repair the transaction by providing the correct identifier.<br /><br /> If the Beneficiary's ClearingSystemMember identifier is missing, the Originator may reissue the payment with the identifier specified.",
"RC12": "Creditor Scheme Id is invalid or missing.",
"RECI": "Further information regarding the intended recipient.",
"RF01": "Transaction reference is not unique within the message.",
"RR01": "Specification of the debtor's account or unique identification needed for reasons of regulatory requirements is insufficient or missing.",
"RR02": "Specification of the debtor's name and/or address needed for regulatory requirements is insufficient or missing.",
"RR03": "Specification of the creditor's name and/or address needed for regulatory requirements is insufficient or missing.<br/><br/><b>Error handling</b><br/>If the Beneficiary's name and/or address information is invalid, the Sending Member may repair the transaction by providing the correct information.<br /><br /> If the Beneficiary's name and/or address information is missing, the Originator may reissue the payment with the Beneficiary's information specified.",
"RR04": "Regulatory Reason. This error typically occurs when there is a restriction due to Anti-Money Laundering (AML), embargo, or compliance reasons.<br/><br/><b>Error handling</b><br/>The Originator may contact the Sending Member to enquire about the reasons for the error and take remedial action as they see fit.",
"RR05": "Regulatory or Central Bank Reporting information missing, incomplete or invalid.<br/><br/><b>Error handling</b><br/>In case of a technical or human error, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not supply invalid or incomplete information. <br /><br />If the Beneficiary provided incorrect information, the Originator may contact the Beneficiary for accurate information.",
"RR06": "Tax information missing, incomplete or invalid.",
"RR07": "Remittance information structure does not comply with rules for payment type.",
"RR10": "Character set supplied not valid for the country and payment type.<br/><br/><b>Error handling</b><br/>In case of a technical or human error, the Sending Member or the Originator must adapt their internal RippleNet payment initiation process to ensure they do not supply an invalid character set. <br /><br />If the Beneficiary provided incorrect information, the Originator may contact the Beneficiary for accurate information.",
"SL03": "Due to a specific service offered by the clearing system.",
"TK01": "Token is invalid.",
"TK02": "Token used for the sender does not exist.",
"TK03": "Token used for the receiver does not exist.",
"TK09": "Token required for request is missing.",
"TKCM": "Token found with counterparty mismatch.",
"TKSG": "Single Use Token already used.",
"TKSP": "Token found with suspended status.",
"TKVE": "Token found with value limit rule violation.",
"TKXP": "Token expired."
}
},
"reason": {
"type": "string",
"description": "Free-form text field to describe the reason in a human readable format."
}
}
}
]
},
"accepting_client_id": {
"description": "This is a system populated field.",
"type": "string"
},
"external_id": {
"description": "This is a sender or receiver populated field, used for their internal usage purposes.",
"type": "string"
},
"SourceOfCash": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Source where funds have come from for the payment.",
"minItems": 1,
"maxItems": 1,
"enum": [
"ALMY",
"CASH",
"COMP",
"EMIN",
"GIFT",
"INHE",
"INLQ",
"PACA",
"REDM",
"REPY",
"REST",
"RETA",
"SALE",
"SEAQ",
"SELF",
"SVGS",
"WINS"
],
"x-enumDescriptions": {
"ALMY": "Alimony",
"CASH": "Cash Proceeds",
"COMP": "Compensation",
"EMIN": "Employee Income",
"GIFT": "Gift",
"INHE": "Inheritance",
"INLQ": "Insurance Premium Liquidation",
"PACA": "Paid Up Capital",
"REDM": "Redemption",
"REPY": "Retirement Policy",
"REST": "Real Estate Sale",
"RETA": "Retained Earnings",
"SALE": "Sale Of Goods",
"SEAQ": "Sale Aquisition Corporation",
"SELF": "Self Employment Income",
"SVGS": "Savings",
"WINS": "Winnings"
}
},
"PmtId": {
"type": "object",
"title": "Payment ID Information",
"description": "Set of elements used to reference a payment instruction.",
"properties": {
"InstrId": {
"description": "Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction.",
"type": "string",
"maxLength": 35
},
"TxId": {
"type": "string",
"description": "Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain.",
"maxLength": 35
},
"ClrSysRef": {
"type": "string",
"description": "Unique reference, as assigned by a clearing system, to unambiguously identify the instruction.",
"maxLength": 35
},
"Uetr": {
"type": "string",
"pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
"description": "Unique End-to-end Transaction Reference, generated by the Payer and passed through, without modification by the payment participants through to the beneficiary.",
"maxLength": 36
}
}
},
"PmtTpInf": {
"type": "object",
"title": "Payment Type Information",
"description": "Set of elements used to further specify the type of transaction.",
"properties": {
"InstrPrty": {
"type": "string",
"description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. List based on ISO20022 Priority2Code List",
"enum": [
"HIGH",
"NORM"
],
"x-enumDescriptions": {
"HIGH": "High importance",
"NORM": "Normal importance"
}
},
"ClrChanl": {
"type": "string",
"description": "List based on ISO20022 ClearingChannel2Code List",
"minItems": 1,
"maxItems": 1,
"enum": [
"RTGS",
"RTNS",
"MPNS",
"BOOK"
],
"x-enumDescriptions": {
"RTGS": "Real Time Gross Settlement System",
"RTNS": "Real Time Net Settlement System",
"MPNS": "Mass Payment Net System",
"BOOK": "Book Transfer"
}
},
"CtgyPurp": {
"type": "object",
"description": "Specifies the high level purpose of the instruction based on a set of pre-defined categories.",
"properties": {
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
},
"Cd": {
"type": "string",
"description": "List based on ISO20022 ExternalCategoryPurpose1Code List [27-Aug-2021](https://www.iso20022.org/sites/default/files/2021-08/ExternalCodeSets_2Q2021.xlsx).",
"minItems": 1,
"maxItems": 1,
"enum": [
"BONU",
"CASH",
"CBLK",
"CCRD",
"CORT",
"DCRD",
"DIVI",
"DVPM",
"EPAY",
"FCIN",
"FCOL",
"GOVT",
"GP2P",
"HEDG",
"ICCP",
"IDCP",
"INTC",
"INTE",
"LBOX",
"LOAN",
"MP2B",
"MP2P",
"OTHR",
"PENS",
"RPRE",
"RRCT",
"RVPM",
"SALA",
"SECU",
"SSBE",
"SUPP",
"TAXS",
"TRAD",
"TREA",
"VATX",
"WHLD"
],
"x-enumDescriptions": {
"BONU": "Bonus Payment",
"CASH": "Cash Management Transfer",
"CBLK": "Card Bulk Clearing",
"CCRD": "Credit Card Payment",
"CORT": "TradeSettlementPayment",
"DCRD": "Debit Card Payment",
"DIVI": "Dividend",
"DVPM": "Deliver Against Payment",
"EPAY": "Epayment",
"FCIN": "Fee Collection and Interest",
"FCOL": "Fee Collection",
"GOVT": "Government Payment",
"GP2P": "Person-to-Person Payment",
"HEDG": "Hedging",
"ICCP": "Irrevocable Credit Card Payment",
"IDCP": "Irrevocable Debit Card Payment",
"INTC": "Intra Company Payment",
"INTE": "Interest",
"LBOX": "Lockbox Transactions",
"LOAN": "Loan",
"MP2B": "Commercial",
"MP2P": "Consumer",
"OTHR": "Other Payment",
"PENS": "Pension Payment",
"RPRE": "Represented",
"RRCT": "Reimbursement Received Credit Transfer",
"RVPM": "Receive Against Payment",
"SALA": "Salary Payment",
"SECU": "Securities",
"SSBE": "Social Security Benefit",
"SUPP": "Supplier Payment",
"TAXS": "Tax Payment",
"TRAD": "Trade",
"TREA": "Treasury Payment",
"VATX": "Value Added Tax Payment",
"WHLD": "WithHolding"
}
}
}
},
"SvcLvl": {
"type": "object",
"description": "Agreement under which or rules under which the transaction should be processed.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on the [27-Aug-2021](https://www.iso20022.org/sites/default/files/2021-08/ExternalCodeSets_2Q2021.xlsx) ISO20022 List ExternalServiceLevel1Code",
"minItems": 1,
"maxItems": 1,
"enum": [
"BKTR",
"NPCA",
"NUGP",
"NURG",
"PRPT",
"SDVA",
"SEPA",
"SVDE",
"URGP",
"URNS",
"G001",
"G002",
"G003",
"G004"
],
"x-enumDescriptions": {
"BKTR": "Book Transaction",
"NPCA": "Nordic Payments Council Area Transfer",
"NUGP": "Non-urgent Priority Payment",
"NURG": "Non-urgent Payment",
"PRPT": "EBA Priority Service",
"SDVA": "Same Day Value",
"SEPA": "Single Euro Payments Area",
"SVDE": "Domestic Cheque Clearing and Settlement",
"URGP": "Urgent Payment",
"URNS": "Urgent Payment Net Settlement",
"G001": "Tracked Customer Credit Transfer",
"G002": "Tracked Stop And Recall",
"G003": "Tracked Corporate Transfer",
"G004": "Tracked Financial Institution Transfer"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"LclInstrm": {
"type": "object",
"description": "User community specific instrument.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ISO20022 List ExternalLocalInstrument1Code",
"enum": [
"DDMC",
"DDMP",
"DDMU",
"TRF",
"82",
"83",
"CPP",
"RTR",
"GST",
"DDT",
"RDD",
"CHN",
"STR",
"SDD",
"SRT",
"SRD",
"SCN",
"SGT",
"CARD",
"05",
"04",
"ISE",
"BSE",
"IN",
"58",
"19",
"85",
"08",
"89",
"60",
"RIBA",
"RIDO",
"RIDV",
"IDEAL",
"INSTNT01",
"INSTTC01",
"INSTIDEAL",
"INSTNT01IDEAL",
"INSTTC01IDEAL",
"NLDO",
"NLUP",
"ACCEPT",
"SDN",
"NLGOV",
"0090",
"0091",
"0092",
"0002",
"0221",
"0224",
"0226",
"0225",
"0222",
"0227",
"0220",
"0223",
"0001",
"0000",
"ONCL",
"SDCL",
"DDNR",
"DDFA",
"CORE",
"B2BAMIPM",
"B2B",
"CR1AMIPM",
"CORAMIPM",
"COR1",
"FADAMIPM",
"CLSCCPERX",
"CLSCCPLCH",
"INST",
"ADD",
"UDD",
"CCI",
"BTR",
"CKS",
"CTR",
"CTP",
"DEP",
"FFR",
"FFS",
"SVC",
"DRW",
"DRB",
"DRC",
"IAT",
"CCD",
"CTX",
"PPD",
"CIE",
"RCK",
"ARC",
"WEB",
"POP",
"POS",
"TEL",
"BPA",
"IPA",
"ASTI",
"BACP",
"MANP",
"SBTI",
"ICMC",
"PERI"
],
"x-enumDescriptions": {
"DDMC": "Direct Debit Confirmed Electronic Mandate",
"DDMP": "Direct Debit Paper Mandate With Paper Authorization",
"DDMU": "Direct Debit Unconfirmed Electronic Mandate",
"TRF": "Credit Transfers",
"82": "Non-pre authorised Direct Debit",
"83": "Pre authorised Direct Debit",
"CPP": "Cash Per Post",
"RTR": "Returned Credit Transfers",
"GST": "Truncated Credit Transfers",
"DDT": "Direct Debits",
"RDD": "Returned Direct Debits",
"CHN": "Truncated Checks",
"STR": "Revoked Credit Transfers",
"SDD": "Revoked Direct Debits",
"SRT": "Revoked Returned Credit Transfers",
"SRD": "Revoked Returned Direct Debits",
"SCN": "Revoked Truncated Checks",
"SGT": "Revoked Truncated Credit Transfers",
"CARD": "Card Clearing",
"05": "Non-pre authorised Direct Debit DE",
"04": "Pre authorised Direct Debit",
"ISE": "Image-based Cheque Collection",
"BSE": "Paperless Cheque Collection",
"IN": "Cross Border Customer Credit Transfer",
"58": "Business-to-business Direct Debit",
"19": "Business-to-customer Direct Debit",
"85": "Pre-authorised Direct Debit Acc\u00e9l\u00e9r\u00e9 (Accelerated clearing / 2 Day) Ordinaire (Normal clearing / 4 Day)",
"08": "Pre-authorised Direct Debit Ordinaire (Normal clearing / 4 Day)",
"89": "Pre-authorised Direct Debit V\u00e9rifi\u00e9 (Verified clearing)",
"60": "Recovered Bill of Exchange or Promissory Note",
"RIBA": "Non-pre authorised direct debit RIBA",
"RIDO": "Pre authorised revocable Direct Debit",
"RIDV": "Pre authorised revocable urgent Direct Debit",
"IDEAL": "Payments via Internet owned by Currence",
"INSTNT01": "Instant Credit Transfer Not Time Critical",
"INSTTC01": "Instant Credit Transfer Time Critical",
"INSTIDEAL": "Payments via Internet owned by Currence using Instant Credit Transfer",
"INSTNT01IDEAL": "Payments via Internet owned by Currence using InstantCreditTransferNotTimeCritical",
"INSTTC01IDEAL": "Payments via Internet owned by Currence using InstantCreditTransferTimeCritical",
"NLDO": "Dutch Domestic Bulk Payment",
"NLUP": "Dutch Urgent Payment",
"ACCEPT": "Payment via Acceptgiro owned by Currence",
"SDN": "Payments via Standaard Digitale Nota",
"NLGOV": "Direct debit initiated by the government with special conditions",
"0090": "Mass Payment Beneficiary",
"0091": "Mass Payment Ours",
"0092": "Mass Payment Shared",
"0002": "Standing Order",
"0221": "One-off Authorisation",
"0224": "One-off Authorisation Charities",
"0226": "One-off Authorisation Construction Industry",
"0225": "One-off Authorisation Tuition Fees",
"0222": "Standing Authorisation Companies",
"0227": "Standing Authorisation Companies Without Debtor Revocation Right",
"0220": "Standing Authorisation General",
"0223": "Standing Authorisation Lotteries",
"0001": "Converted (Bank) Payment",
"0000": "Business Payment",
"ONCL": "Overnight",
"SDCL": "Same Day",
"DDNR": "Core No Refund",
"DDFA": "Direct Debit Fixed Amount",
"CORE": "SEPA Direct Debit - Core",
"B2BAMIPM": "SEPA B2B Direct Debit AMI",
"B2B": "SEPA Business to Business Direct Debit",
"CR1AMIPM": "SEPA Core D-1 Direct Debit AMI",
"CORAMIPM": "SEPA Core Direct Debit AMI",
"COR1": "SEPA Direct Debit - 1 Day Settlement",
"FADAMIPM": "SEPA FA Direct Debit AMI",
"CLSCCPERX": "CLS Cleared FX For Eurex",
"CLSCCPLCH": "CLS Cleared FX For LCH",
"INST": "Instant Credit Transfer",
"ADD": "Authenticated Direct Debit for Domestic Use",
"UDD": "Unauthenticated Direct Debit for Domestic Use",
"CCI": "Cash Concentration Intragroup",
"BTR": "Bank Transfer",
"CKS": "Check Same Day Settlement Wire",
"CTR": "Customer Transfer",
"CTP": "Customer Transfer Plus",
"DEP": "Deposit to Senders Account",
"FFR": "Fed Funds Returned",
"FFS": "Fed Funds Sold",
"SVC": "Non-Value Service Message",
"DRW": "Drawdown Response (Value) to Honor a Drawdown Request",
"DRB": "Bank-to-Bank Drawdown Request or Response (Non-value)",
"DRC": "Customer or Corporate Drawdown Request or Response (Non-value)",
"IAT": "International ACH",
"CCD": "Cash Concentration or Disbursement Corporate counterparty.",
"CTX": "Corporate Trade Exchange",
"PPD": "Prearranged Payment or Deposit. Consumer counterparty.",
"CIE": "Customer Initiated Entry",
"RCK": "Re-presented Check Entry",
"ARC": "Accounts Receivable Check",
"WEB": "Internet Initiated Entry",
"POP": "Point-Of-Purchase",
"POS": "Point-Of-Sale",
"TEL": "Telephone Initiated Entry",
"BPA": "Batch Payments Aruba",
"IPA": "Instant Payments Aruba",
"ASTI": "Ancillary System Transfer Initiation",
"BACP": "Backup Payment",
"MANP": "Mandated Payment",
"SBTI": "Settlement Bank Transfer Initiation",
"ICMC": "IncidentManagementCorrection",
"PERI": "PaymentWithERI"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
}
}
},
"ChrgBr": {
"description": "ISO ChargeBearerType1Code that specifies which party or parties will bear the charges associated with the processing of the payment transaction.",
"type": "string",
"minItems": 1,
"maxItems": 1,
"enum": [
"DEBT",
"CRED",
"SHAR"
],
"x-enumDescriptions": {
"DEBT": "Borne By Debtor",
"CRED": "Borne By Creditor",
"SHAR": "Shared"
}
},
"UltmtDbtr": {
"type": "object",
"title": "Ultimate Debtor Information",
"description": "Ultimate party that owes an amount of money to the (ultimate) creditor.",
"properties": {
"Nm": {
"type": "string",
"description": "Allows the name of the Ultimate Debtor to be held as a single value. <br/><ul><li>Must include one (1) name string.<li>Allowable characters: Alphanumeric and space.<li>Names with multiple words must be separated by a space.<li>For example, specify \"Widgets Org\", as `Widgets Org`.<li>Provide a truncated name if longer than 140 characters.",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 140
},
"StrdNm": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Allows the name of the Ultimate Debtor to be held in a structured format.",
"required": [
"FirstNm",
"LastNm"
],
"properties": {
"FirstNm": {
"description": "First name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the first name has two or more words, separate them with a space.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.<li>Provide a truncated name if longer than allowable characters.</ul><b>Example</b></br><ul><li>If the party's full name is 'Norma-Jean Baker' where 'Norma-Jean' is the first name, the `StrdNm.FirstNm` value must be 'Norma Jean'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"MidNm": {
"description": "Middle name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm": {
"description": "Last name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the last name has two or more words, separate them with a space.<li>Provide a truncated name if longer than allowable characters.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.</ul><b>Example</b></br><ul><li>If the party's full name is 'Enrique Miguel Iglesias Preysler,' where 'Iglesias Preysler' is the last name, the `StrdNm.LastNm` value must be 'Iglesias Preysler'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm2": {
"description": "Secondary last name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"NtrlNm": {
"description": "Name in local character set or language.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Title": {
"description": "Title by which the party is known and which is usually used to identify the party.",
"type": "string",
"minLength": 1,
"maxLength": 20
}
}
},
"CtryOfRes": {
"type": "string",
"description": "The ISO country code of the Ultimate Debtor's country of residence.<br/>Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list.",
"pattern": "^[A-Z]{2}$"
},
"PstlAdr": {
"type": "object",
"description": "Allows the address of the Ultimate Debtor to be held.",
"properties": {
"AdrTp": {
"type": "string",
"description": "Specifies the type of address based on the [ISO20022 AddressType1Code](https://www.iso20022.org/standardsrepository/type/AddressType1Code) list",
"minItems": 1,
"maxItems": 1,
"enum": [
"ADDR",
"PBOX",
"HOME",
"BIZZ",
"MLTO",
"DLVY"
],
"x-enumDescriptions": {
"ADDR": "Postal",
"PBOX": "PO Box",
"HOME": "Residential",
"BIZZ": "Business",
"MLTO": "Mail To",
"DLVY": "Delivery To"
}
},
"AdrLine": {
"description": "Information that locates and identifies the address for the party.",
"type": "array",
"maxLength": 70
},
"Dept": {
"description": "Information that locates and identifies the department for the party.",
"type": "string",
"maxLength": 70
},
"SubDept": {
"description": "Information that locates and identifies the sub department for the party.",
"type": "string",
"maxLength": 70
},
"StrtNm": {
"description": "Information that locates and identifies the street name for the party, as defined by postal services.",
"type": "string",
"maxLength": 70
},
"BldgNb": {
"description": "Information that locates and identifies the building number for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"PstCd": {
"description": "Information that locates and identifies postal code for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"TwnNm": {
"description": "Information that locates and identifies the city / town for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"CtrySubDvsn": {
"description": "Information that locates and identifies the state / county for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"Ctry": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country for the party, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list."
}
}
},
"CtctDtls": {
"type": "object",
"description": "Allows the Country of Residence of the Ultimate Debtor to be held.",
"properties": {
"NmPrfx": {
"type": "string",
"description": "List based on ISO 20022 NamePrefix1Code List",
"enum": [
"DOCT",
"MIST",
"MISS",
"MADM"
],
"x-enumDescriptions": {
"DOCT": "Doctor",
"MIST": "Mister",
"MISS": "Miss",
"MADM": "Madam"
}
},
"Nm": {
"type": "string",
"description": "Name by which a party is known and which is usually used to identify that party.",
"maxLength": 140
},
"PhneNb": {
"type": "string",
"description": "Phone Number",
"maxLength": 15,
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"MobNb": {
"type": "string",
"description": "Mobile Phone Number",
"maxLength": 15,
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"FaxNb": {
"type": "string",
"description": "Fax Number",
"maxLength": 15,
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"EmailAdr": {
"type": "string",
"description": "Address for electronic mail (e-mail).",
"format": "email",
"maxLength": 2048
},
"Othr": {
"type": "string",
"description": "Contact details in another form.",
"maxLength": 35
}
}
},
"Id": {
"type": "object",
"description": "Unique and unambiguous way to identify the Ultimate Debtor.",
"properties": {
"OrgId": {
"type": "object",
"description": "Unique and unambiguous way to identify an individual or organization.",
"properties": {
"AnyBIC": {
"type": "string",
"pattern": "^([a-zA-Z0-9_-]){8,11}$",
"description": "The Business identifier code (BIC) allocated to a receiving institution by the [ISO 9362 Registration Authority](https://www.iso.org/standard/84108.html)."
},
"DtAndPlcofIncorprtn": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the organization's date and place of incorporation.",
"properties": {
"DtofIncorprtn": {
"type": "string",
"description": "The date of incorporation for the organization.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"CtryofIncorprtn": {
"type": "string",
"description": "Information that locates and identifies the country, as defined by postal services where the organization was incorporated. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.",
"pattern": "^[A-Z]{2}"
}
}
},
"Othr": {
"type": "array",
"description": "An array of objects, each containing unique identification of an organization, as assigned by an institution, using an identification scheme.",
"items": {
"type": "object",
"properties": {
"Id": {
"description": "Identification assigned by an institution.",
"type": "string",
"maxLength": 35
},
"Issr": {
"description": "Entity that assigns the identification.",
"type": "string",
"maxLength": 35
},
"DtOfIsse": {
"description": "The date of issuance of the supporting documentation.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"DtOfXpry": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>The date of expiration of the supporting documentation.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"SchmeNm": {
"type": "object",
"description": "Name of the organization identification scheme.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ExternalorganizationIdentification1Code List",
"enum": [
"BANK",
"CBID",
"CHID",
"CINC",
"COID",
"CUST",
"DUNS",
"EMPL",
"GS1G",
"SREN",
"SRET",
"TXID",
"USCC"
],
"x-enumDescriptions": {
"BANK": "Bank Party Identification",
"CBID": "Central Bank Identification Number",
"CHID": "Clearing Identification Number",
"CINC": "Certificate Of Incorporation Number",
"COID": "Country Identification Code",
"CUST": "Customer Number",
"DUNS": "Data Universal Numbering System",
"EMPL": "Employer Identification Number",
"GS1G": "GS1GLN Identifier",
"SREN": "SIREN",
"SRET": "SIRET",
"TXID": "Tax Identification Number",
"USCC": "Unified Social Credit Code"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
}
}
}
},
"RelShipToCdtr": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the relationship between the Sender and Receiver.",
"enum": [
"BRAN",
"CUST",
"FRAN",
"HOLD",
"PART",
"SUBS",
"SUPP"
],
"x-enumDescriptions": {
"BRAN": "Branch or representative office",
"CUST": "Customer",
"FRAN": "Franchisee or franchisor",
"HOLD": "Holding company",
"PART": "Business partner",
"SUBS": "Subsidiary company",
"SUPP": "Supplier"
}
},
"Rprtv": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the name of the organization's representative.",
"properties": {
"StrdNm": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Allows the name of the organization's representative to be held in a structured format.",
"required": [
"FirstNm",
"LastNm"
],
"properties": {
"FirstNm": {
"description": "First name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the first name has two or more words, separate them with a space.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.<li>Provide a truncated name if longer than allowable characters.</ul><b>Example</b></br><ul><li>If the party's full name is 'Norma-Jean Baker' where 'Norma-Jean' is the first name, the `StrdNm.FirstNm` value must be 'Norma Jean'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"MidNm": {
"description": "Middle name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm": {
"description": "Last name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the last name has two or more words, separate them with a space.<li>Provide a truncated name if longer than allowable characters.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.</ul><b>Example</b></br><ul><li>If the party's full name is 'Enrique Miguel Iglesias Preysler,' where 'Iglesias Preysler' is the last name, the `StrdNm.LastNm` value must be 'Iglesias Preysler'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm2": {
"description": "Secondary last name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"NtrlNm": {
"description": "Name in local character set or language.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Title": {
"description": "Title by which the party is known and which is usually used to identify the party.",
"type": "string",
"minLength": 1,
"maxLength": 20
}
}
}
}
}
}
},
"PrvtId": {
"type": "object",
"description": "Unique and unambiguous identification of a person, e.g., passport.",
"properties": {
"DtAndPlcOfBirth": {
"type": "object",
"description": "Date and place of birth of a person.",
"properties": {
"BirthDt": {
"description": "Information that identifies the date of Birth for the party.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"PrvcOfBirth": {
"description": "Information that locates and identifies the Province of birth for the party.",
"type": "string",
"maxLength": 35
},
"CityOfBirth": {
"description": "Information that locates and identifies the city of birth for the party.",
"type": "string",
"maxLength": 35
},
"CtryOfBirth": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country of birth for the party, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list."
}
}
},
"Othr": {
"type": "array",
"description": "An array of objects, each containing the unique identification of a party, as assigned by an institution, using an identification scheme.",
"items": {
"type": "object",
"properties": {
"Id": {
"description": "Value to be used to identify the party",
"type": "string",
"maxLength": 35
},
"Issr": {
"description": "Information for the Entity that assigns the identification.",
"type": "string",
"maxLength": 35
},
"SchmeNm": {
"type": "object",
"description": "Name of the identification scheme used to identify an individual.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ISO20022 ExternalPersonIdentification1Code List ",
"enum": [
"ARNU",
"CCPT",
"CUST",
"DRLC",
"EMPL",
"NIDN",
"SOS",
"TELE",
"TXID"
],
"x-enumDescriptions": {
"ARNU": "Alien Registration Number",
"CCPT": "Passport Number",
"CUST": "Customer Identification Number",
"DRLC": "Drivers License Number",
"EMPL": "Employee Identification Number",
"NIDN": "National Identity Number",
"SOS": "Social Security Number",
"TELE": "Telephone Number",
"TXID": "Tax Identification Number"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"DtOfIss": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Issue date of the supporting documentation.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"DtOfXpry": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Expiration date of the supporting documentation.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"MrzNb": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Machine Readable Zone for Passport. This field only applies if the ID is a passport.",
"type": "string",
"maxLength": 88,
"pattern": "^[A-Z<]{1}[A-Z0-9<]{1}[A-Z<]{3}[0-9<]{6}[A0-9<]{1}[0-9<]{1}[A0-9<]{7}[A-Z<]{1}[0-9<]{1}[0-9<]{3}[A0-9<]{1}[0-9<]{1}[A0-9<]{7}[0-9<]{14}$"
}
}
}
},
"Gndr": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Information that captures the Gender of a party.",
"type": "string",
"maxLength": 6,
"enum": [
"Male",
"Female",
"Other"
],
"x-enumDescriptions": {
"Male": "Male",
"Female": "Female",
"Other": "Other"
}
},
"Prfssn": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Information that captures the occupation of a party.",
"type": "string",
"maxLength": 35
},
"RelShipToCdtr": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Relationship of the receiving party to the sending party.<br/><strong>Note</strong>: This information is required within the creditor object `cdtr` for payout in the Philippines.",
"type": "string",
"enum": [
"CHIL",
"CUST",
"EMPL",
"EXSP",
"FREN",
"OTHR",
"PARE",
"PART",
"RELA",
"SELF",
"SIBL",
"SPOU",
"VEND"
],
"x-enumDescriptions": {
"CHIL": "Child",
"CUST": "Customer",
"EMPL": "Employee",
"EXSP": "Ex-spouse",
"FREN": "Friend",
"OTHR": "Other",
"PARE": "Parent",
"PART": "Business partner",
"RELA": "Relation",
"SELF": "Self",
"SIBL": "Sibling",
"SPOU": "Covering Spouse/Partner",
"VEND": "Vendor"
}
},
"Ntlty": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "ISO Country Code of nationality of the party.<br/><br/>Deprecated in favor of `UltmtDbtr.PrvtId.Ctznsh.Ntlty`",
"maxLength": 3,
"deprecated": {
"description": "Deprecated in favor of `UltmtDbtr.PrvtId.Ctznsh.Ntlty`",
"deprecatedVersion": "1.1"
}
},
"Residence": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "ISO Country Code of residence of the party.<br/><br/>Deprecated: Must be served by `UltmtDbtr.CtryOfRes`",
"maxLength": 3,
"deprecated": {
"description": "Must be served by `UltmtDbtr.CtryOfRes`.",
"deprecatedVersion": "As per latest ISO 20022 PACS.008 standard."
}
},
"Ctznsh": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Describes the citizenship.",
"properties": {
"Ntlty": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Nationality of the party. Use ISO Country Code for values.",
"maxLength": 3
},
"MnrId": {
"description": "Indicates whether the party is a minor.",
"type": "string",
"enum": [
"YES",
"NO"
],
"x-enumDescriptions": {
"YES": "Party is a minor.",
"NO": "Party is not a minor."
}
},
"StartDt": {
"description": "Start date of citizenship for the party.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"EndDt": {
"description": "End date of citizenship for the party.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
}
}
}
}
}
}
}
}
},
"InitgPty": {
"type": "object",
"title": "Initiating Party Information",
"description": "Party that initiates the payment.",
"properties": {
"Nm": {
"type": "string",
"description": "Allows the name of the Initiating Party to be held as a single value.<br/><ul><li>Must include one (1) name string.<li>Allowable characters: Alphanumeric and space.<li>Names with multiple words must be separated by a space.<li>For example, specify \"Widgets Org\", as `Widgets Org`.<li>Provide a truncated name if longer than 140 characters.",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 140
},
"StrdNm": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Allows the name of the Initiating Party to be held in a structured format.",
"required": [
"FirstNm",
"LastNm"
],
"properties": {
"FirstNm": {
"description": "First name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the first name has two or more words, separate them with a space.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.<li>Provide a truncated name if longer than allowable characters.</ul><b>Example</b></br><ul><li>If the party's full name is 'Norma-Jean Baker' where 'Norma-Jean' is the first name, the `StrdNm.FirstNm` value must be 'Norma Jean'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"MidNm": {
"description": "Middle name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm": {
"description": "Last name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the last name has two or more words, separate them with a space.<li>Provide a truncated name if longer than allowable characters.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.</ul><b>Example</b></br><ul><li>If the party's full name is 'Enrique Miguel Iglesias Preysler,' where 'Iglesias Preysler' is the last name, the `StrdNm.LastNm` value must be 'Iglesias Preysler'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm2": {
"description": "Secondary last name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"NtrlNm": {
"description": "Name in local character set or language.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Title": {
"description": "Title by which the party is known and which is usually used to identify the party.",
"type": "string",
"minLength": 1,
"maxLength": 20
}
}
},
"PstlAdr": {
"type": "object",
"description": "Allows the address of the Initiating Party to be held.",
"properties": {
"AdrTp": {
"type": "string",
"description": "Specifies the type of address based on the [ISO20022 AddressType1Code](https://www.iso20022.org/standardsrepository/type/AddressType1Code) list",
"minItems": 1,
"maxItems": 1,
"enum": [
"ADDR",
"PBOX",
"HOME",
"BIZZ",
"MLTO",
"DLVY"
],
"x-enumDescriptions": {
"ADDR": "Postal",
"PBOX": "PO Box",
"HOME": "Residential",
"BIZZ": "Business",
"MLTO": "Mail To",
"DLVY": "Delivery To"
}
},
"AdrLine": {
"description": "Information that locates and identifies the address for the party.",
"type": "array",
"maxLength": 70
},
"Dept": {
"description": "Information that locates and identifies the department for the party.",
"type": "string",
"maxLength": 70
},
"SubDept": {
"description": "Information that locates and identifies the sub department for the party.",
"type": "string",
"maxLength": 70
},
"StrtNm": {
"description": "Information that locates and identifies the street name for the party, as defined by postal services.",
"type": "string",
"maxLength": 70
},
"BldgNb": {
"description": "Information that locates and identifies the building number for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"PstCd": {
"description": "Information that locates and identifies postal code for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"TwnNm": {
"description": "Information that locates and identifies the city / town for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"CtrySubDvsn": {
"description": "Information that locates and identifies the state / county for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"Ctry": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country for the party, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list."
}
}
},
"Id": {
"type": "object",
"description": "Unique and unambiguous way to identify the Initiating Party.",
"properties": {
"OrgId": {
"type": "object",
"description": "Unique and unambiguous way to identify an individual or organization.",
"properties": {
"AnyBIC": {
"type": "string",
"pattern": "^([a-zA-Z0-9_-]){8,11}$",
"description": "The Business identifier code (BIC) allocated to a receiving institution by the [ISO 9362 Registration Authority](https://www.iso.org/standard/84108.html).<br/><br/><b>Example</b>: `BANKGB22`"
},
"DtAndPlcofIncorprtn": {
"type": "object",
"description": "<b>[Soft field](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the organization's date and place of incorporation.",
"properties": {
"DtofIncorprtn": {
"type": "string",
"description": "The date of incorporation for the organization.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"CtryofIncorprtn": {
"type": "string",
"description": "Information that locates and identifies the country, as defined by postal services where the organization was incorporated. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.",
"pattern": "^[A-Z]{2}"
}
}
},
"Othr": {
"type": "array",
"description": "An array of objects, each containing unique identification of an organization, as assigned by an institution, using an identification scheme.",
"items": {
"type": "object",
"properties": {
"Id": {
"description": "Identification assigned by an institution.",
"type": "string",
"maxLength": 35
},
"Issr": {
"description": "Entity that assigns the identification.",
"type": "string",
"maxLength": 35
},
"DtOfIsse": {
"description": "The date of issuance of the supporting documentation.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"DtOfXpry": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>The date of expiration of the supporting documentation.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"SchmeNm": {
"type": "object",
"description": "Name of the organization identification scheme.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ExternalorganizationIdentification1Code List",
"enum": [
"BANK",
"CBID",
"CHID",
"CINC",
"COID",
"CUST",
"DUNS",
"EMPL",
"GS1G",
"SREN",
"SRET",
"TXID",
"USCC"
],
"x-enumDescriptions": {
"BANK": "Bank Party Identification",
"CBID": "Central Bank Identification Number",
"CHID": "Clearing Identification Number",
"CINC": "Certificate Of Incorporation Number",
"COID": "Country Identification Code",
"CUST": "Customer Number",
"DUNS": "Data Universal Numbering System",
"EMPL": "Employer Identification Number",
"GS1G": "GS1GLN Identifier",
"SREN": "SIREN",
"SRET": "SIRET",
"TXID": "Tax Identification Number",
"USCC": "Unified Social Credit Code"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
}
}
}
},
"RelShipToDbtr": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the relationship between the Sender and Receiver.",
"enum": [
"BRAN",
"CUST",
"FRAN",
"HOLD",
"PART",
"SUBS",
"SUPP"
],
"x-enumDescriptions": {
"BRAN": "Branch or representative office",
"CUST": "Customer",
"FRAN": "Franchisee or franchisor",
"HOLD": "Holding company",
"PART": "Business partner",
"SUBS": "Subsidiary company",
"SUPP": "Supplier"
}
},
"RelShipToCdtr": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the relationship between the Sender and Receiver.",
"enum": [
"BRAN",
"CUST",
"FRAN",
"HOLD",
"PART",
"SUBS",
"SUPP"
],
"x-enumDescriptions": {
"BRAN": "Branch or representative office",
"CUST": "Customer",
"FRAN": "Franchisee or franchisor",
"HOLD": "Holding company",
"PART": "Business partner",
"SUBS": "Subsidiary company",
"SUPP": "Supplier"
}
},
"Rprtv": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the name of the organization's representative.",
"properties": {
"StrdNm": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Allows the name of the organization's representative to be held in a structured format.",
"required": [
"FirstNm",
"LastNm"
],
"properties": {
"FirstNm": {
"description": "First name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the first name has two or more words, separate them with a space.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.<li>Provide a truncated name if longer than allowable characters.</ul><b>Example</b></br><ul><li>If the party's full name is 'Norma-Jean Baker' where 'Norma-Jean' is the first name, the `StrdNm.FirstNm` value must be 'Norma Jean'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"MidNm": {
"description": "Middle name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm": {
"description": "Last name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the last name has two or more words, separate them with a space.<li>Provide a truncated name if longer than allowable characters.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.</ul><b>Example</b></br><ul><li>If the party's full name is 'Enrique Miguel Iglesias Preysler,' where 'Iglesias Preysler' is the last name, the `StrdNm.LastNm` value must be 'Iglesias Preysler'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm2": {
"description": "Secondary last name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"NtrlNm": {
"description": "Name in local character set or language.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Title": {
"description": "Title by which the party is known and which is usually used to identify the party.",
"type": "string",
"minLength": 1,
"maxLength": 20
}
}
}
}
}
}
},
"PrvtId": {
"type": "object",
"description": "Unique and unambiguous identification of a person, e.g., passport.",
"properties": {
"DtAndPlcOfBirth": {
"type": "object",
"description": "Date and place of birth of a person.",
"properties": {
"BirthDt": {
"description": "Information that identifies the date of Birth for the party.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"PrvcOfBirth": {
"description": "Information that locates and identifies the Province of birth for the party.",
"type": "string",
"maxLength": 35
},
"CityOfBirth": {
"description": "Information that locates and identifies the city of birth for the party.",
"type": "string",
"maxLength": 35
},
"CtryOfBirth": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country of birth for the party, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list."
}
}
},
"Othr": {
"type": "array",
"description": "An array of objects, each containing the unique identification of a party, as assigned by an institution, using an identification scheme.",
"items": {
"type": "object",
"properties": {
"Id": {
"description": "Value to be used to identify the party",
"type": "string",
"maxLength": 35
},
"Issr": {
"description": "Information for the Entity that assigns the identification.",
"type": "string",
"maxLength": 35
},
"SchmeNm": {
"type": "object",
"description": "Name of the identification scheme used to identify an individual.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ISO20022 ExternalPersonIdentification1Code List ",
"enum": [
"ARNU",
"CCPT",
"CUST",
"DRLC",
"EMPL",
"NIDN",
"SOS",
"TELE",
"TXID"
],
"x-enumDescriptions": {
"ARNU": "Alien Registration Number",
"CCPT": "Passport Number",
"CUST": "Customer Identification Number",
"DRLC": "Drivers License Number",
"EMPL": "Employee Identification Number",
"NIDN": "National Identity Number",
"SOS": "Social Security Number",
"TELE": "Telephone Number",
"TXID": "Tax Identification Number"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"DtOfIss": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Issue date of the ID.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"DtOfXpry": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Expiry date of the ID.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"MrzNb": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Machine Readable Zone for Passport. This field only applies if the ID is a passport.",
"type": "string",
"maxLength": 88,
"pattern": "^[A-Z<]{1}[A-Z0-9<]{1}[A-Z<]{3}[0-9<]{6}[A0-9<]{1}[0-9<]{1}[A0-9<]{7}[A-Z<]{1}[0-9<]{1}[0-9<]{3}[A0-9<]{1}[0-9<]{1}[A0-9<]{7}[0-9<]{14}$"
}
}
}
},
"Gndr": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Information that captures the Gender of a party.",
"type": "string",
"maxLength": 6,
"enum": [
"Male",
"Female",
"Other"
],
"x-enumDescriptions": {
"Male": "Male",
"Female": "Female",
"Other": "Other"
}
},
"Prfssn": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Information that captures the occupation of a party.",
"type": "string",
"maxLength": 35
},
"RelShipToDbtr": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Relationship of the receiving party to the sending party.<br/><strong>Note</strong>: This information is required within the creditor object `cdtr` for payout in the Philippines.",
"type": "string",
"enum": [
"CHIL",
"CUST",
"EMPL",
"EXSP",
"FREN",
"OTHR",
"PARE",
"PART",
"RELA",
"SELF",
"SIBL",
"SPOU",
"VEND"
],
"x-enumDescriptions": {
"CHIL": "Child",
"CUST": "Customer",
"EMPL": "Employee",
"EXSP": "Ex-spouse",
"FREN": "Friend",
"OTHR": "Other",
"PARE": "Parent",
"PART": "Business partner",
"RELA": "Relation",
"SELF": "Self",
"SIBL": "Sibling",
"SPOU": "Covering Spouse/Partner",
"VEND": "Vendor"
}
},
"RelShipToCdtr": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Relationship of the receiving party to the sending party.<br/><strong>Note</strong>: This information is required within the creditor object `cdtr` for payout in the Philippines.",
"type": "string",
"enum": [
"CHIL",
"CUST",
"EMPL",
"EXSP",
"FREN",
"OTHR",
"PARE",
"PART",
"RELA",
"SELF",
"SIBL",
"SPOU",
"VEND"
],
"x-enumDescriptions": {
"CHIL": "Child",
"CUST": "Customer",
"EMPL": "Employee",
"EXSP": "Ex-spouse",
"FREN": "Friend",
"OTHR": "Other",
"PARE": "Parent",
"PART": "Business partner",
"RELA": "Relation",
"SELF": "Self",
"SIBL": "Sibling",
"SPOU": "Covering Spouse/Partner",
"VEND": "Vendor"
}
},
"Ntlty": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>ISO country code of nationality of the party.",
"maxLength": 3
},
"Residence": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Country of residence of the party. Use ISO Country Code for value.",
"maxLength": 3
},
"Ctznsh": {
"type": "object",
"properties": {
"Ntlty": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Nationality of the party. Use ISO Country Code for values.",
"maxLength": 3
},
"MnrId": {
"description": "Indicates whether the party is a minor.",
"type": "string",
"enum": [
"YES",
"NO"
],
"x-enumDescriptions": {
"YES": "Party is a minor.",
"NO": "Party is not a minor."
}
},
"StartDt": {
"description": "Start date of citizenship for the party.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"EndDt": {
"description": "End date of citizenship for the party.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
}
}
}
}
}
}
},
"CtryOfRes": {
"type": "string",
"description": "Allows the Country of Residence of the Initiating Party to be held. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list.",
"pattern": "^[A-Z]{2}$"
},
"CtctDtls": {
"type": "object",
"description": "Allows the contact of the Initiating Party to be held.",
"properties": {
"NmPrfx": {
"type": "string",
"description": "List based on ISO 20022 NamePrefix1Code List",
"enum": [
"DOCT",
"MIST",
"MISS",
"MADM"
],
"x-enumDescriptions": {
"DOCT": "Doctor",
"MIST": "Mister",
"MISS": "Miss",
"MADM": "Madam"
}
},
"Nm": {
"type": "string",
"description": "Name by which a party is known and which is usually used to identify that party.",
"maxLength": 140
},
"PhneNb": {
"type": "string",
"description": "Phone Number",
"maxLength": 15,
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"MobNb": {
"type": "string",
"description": "Mobile Phone Number",
"maxLength": 15,
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"FaxNb": {
"type": "string",
"description": "Fax Number",
"maxLength": 15,
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"EmailAdr": {
"type": "string",
"description": "Address for electronic mail (e-mail).",
"format": "email",
"maxLength": 2048
},
"Othr": {
"type": "string",
"description": "Contact details in another form.",
"maxLength": 35
}
}
}
}
},
"Dbtr": {
"type": "object",
"title": "Debtor Information",
"description": "Party that owes an amount of money to the (ultimate) creditor.",
"properties": {
"Nm": {
"type": "string",
"description": "Allows the name of the Debtor to be held as a single value.</br><ul><li>Required if the Debtor is an organization.</li><li>Not applicable if the Debtor is an individual, specify `StrdNm` instead.</li></ul><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>Allowable characters: Alphanumeric and space.<li>Names with multiple words must be separated by a space.<li>For example, specify \"Widgets Org\", as `Widgets Org`.<li>Provide a truncated name if longer than 140 characters.",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 140
},
"StrdNm": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Allows the name of the Debtor to be held in a structured format.</br><ul><li>Required if the Debtor is an individual.</li><li>Not applicable if the Debtor is an organization, use `Nm` instead of `StrdNm`.</li></ul>",
"required": [
"FirstNm",
"LastNm"
],
"properties": {
"FirstNm": {
"description": "First name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the first name has two or more words, separate them with a space.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.<li>Provide a truncated name if longer than allowable characters.</ul><b>Example</b></br><ul><li>If the party's full name is 'Norma-Jean Baker' where 'Norma-Jean' is the first name, the `StrdNm.FirstNm` value must be 'Norma Jean'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"MidNm": {
"description": "Middle name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm": {
"description": "Last name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the last name has two or more words, separate them with a space.<li>Provide a truncated name if longer than allowable characters.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.</ul><b>Example</b></br><ul><li>If the party's full name is 'Enrique Miguel Iglesias Preysler,' where 'Iglesias Preysler' is the last name, the `StrdNm.LastNm` value must be 'Iglesias Preysler'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm2": {
"description": "Secondary last name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"NtrlNm": {
"description": "Name in local character set or language.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Title": {
"description": "Title by which the party is known and which is usually used to identify the party.",
"type": "string",
"minLength": 1,
"maxLength": 20
}
}
},
"CtryOfRes": {
"type": "string",
"description": "Allows the Country of Residence of the Debtor to be held. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list.",
"pattern": "^[A-Z]{2}$"
},
"PstlAdr": {
"type": "object",
"description": "Allows the address of the Debtor to be held.",
"required": [
"Ctry"
],
"properties": {
"AdrTp": {
"type": "string",
"description": "Specifies the type of address based on the [ISO20022 AddressType1Code](https://www.iso20022.org/standardsrepository/type/AddressType1Code) list",
"minItems": 1,
"maxItems": 1,
"enum": [
"ADDR",
"PBOX",
"HOME",
"BIZZ",
"MLTO",
"DLVY"
],
"x-enumDescriptions": {
"ADDR": "Postal",
"PBOX": "PO Box",
"HOME": "Residential",
"BIZZ": "Business",
"MLTO": "Mail To",
"DLVY": "Delivery To"
}
},
"AdrLine": {
"description": "Information that locates and identifies the address for the party.",
"type": "array",
"maxLength": 70
},
"Dept": {
"description": "Information that locates and identifies the department for the party.",
"type": "string",
"maxLength": 70
},
"SubDept": {
"description": "Information that locates and identifies the sub department for the party.",
"type": "string",
"maxLength": 70
},
"StrtNm": {
"description": "Information that locates and identifies the street name for the party, as defined by postal services.",
"type": "string",
"maxLength": 70
},
"BldgNb": {
"description": "Information that locates and identifies the building number for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"PstCd": {
"description": "Information that locates and identifies postal code for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"TwnNm": {
"description": "Information that locates and identifies the city / town for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"CtrySubDvsn": {
"description": "Information that locates and identifies the state / county for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"Ctry": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country for the party, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list."
}
}
},
"Id": {
"type": "object",
"description": "Unique and unambiguous way to identify the Debtor.",
"properties": {
"OrgId": {
"type": "object",
"description": "Unique and unambiguous way to identify an individual or organization.",
"properties": {
"AnyBIC": {
"type": "string",
"pattern": "^([a-zA-Z0-9_-]){8,11}$",
"description": "The Business identifier code (BIC) allocated to a receiving institution by the [ISO 9362 Registration Authority](https://www.iso.org/standard/84108.html)."
},
"DtAndPlcofIncorprtn": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the organization's date and place of incorporation.",
"properties": {
"DtofIncorprtn": {
"type": "string",
"description": "The date of incorporation for the organization.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"CtryofIncorprtn": {
"type": "string",
"description": "Information that locates and identifies the country, as defined by postal services where the organization was incorporated. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.",
"pattern": "^[A-Z]{2}"
}
}
},
"Othr": {
"type": "array",
"description": "An array of objects, each containing unique identification of an organization, as assigned by an institution, using an identification scheme.",
"items": {
"type": "object",
"properties": {
"Id": {
"description": "Identification assigned by an institution.",
"type": "string",
"maxLength": 35
},
"Issr": {
"description": "Entity that assigns the identification.",
"type": "string",
"maxLength": 35
},
"DtOfIsse": {
"description": "The date of issuance of the supporting documentation.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"DtOfXpry": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>The date of expiration of the supporting documentation.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"SchmeNm": {
"type": "object",
"description": "Name of the organization identification scheme.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ExternalorganizationIdentification1Code List",
"enum": [
"BANK",
"CBID",
"CHID",
"CINC",
"COID",
"CUST",
"DUNS",
"EMPL",
"GS1G",
"SREN",
"SRET",
"TXID",
"USCC"
],
"x-enumDescriptions": {
"BANK": "Bank Party Identification",
"CBID": "Central Bank Identification Number",
"CHID": "Clearing Identification Number",
"CINC": "Certificate Of Incorporation Number",
"COID": "Country Identification Code",
"CUST": "Customer Number",
"DUNS": "Data Universal Numbering System",
"EMPL": "Employer Identification Number",
"GS1G": "GS1GLN Identifier",
"SREN": "SIREN",
"SRET": "SIRET",
"TXID": "Tax Identification Number",
"USCC": "Unified Social Credit Code"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
}
}
}
},
"RelShipToCdtr": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the relationship between the Sender and Receiver.",
"enum": [
"BRAN",
"CUST",
"FRAN",
"HOLD",
"PART",
"SUBS",
"SUPP"
],
"x-enumDescriptions": {
"BRAN": "Branch or representative office",
"CUST": "Customer",
"FRAN": "Franchisee or franchisor",
"HOLD": "Holding company",
"PART": "Business partner",
"SUBS": "Subsidiary company",
"SUPP": "Supplier"
}
},
"Rprtv": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the name of the organization's representative.",
"properties": {
"StrdNm": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Allows the name of the organization's representative to be held in a structured format.",
"required": [
"FirstNm",
"LastNm"
],
"properties": {
"FirstNm": {
"description": "First name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the first name has two or more words, separate them with a space.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.<li>Provide a truncated name if longer than allowable characters.</ul><b>Example</b></br><ul><li>If the party's full name is 'Norma-Jean Baker' where 'Norma-Jean' is the first name, the `StrdNm.FirstNm` value must be 'Norma Jean'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"MidNm": {
"description": "Middle name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm": {
"description": "Last name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the last name has two or more words, separate them with a space.<li>Provide a truncated name if longer than allowable characters.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.</ul><b>Example</b></br><ul><li>If the party's full name is 'Enrique Miguel Iglesias Preysler,' where 'Iglesias Preysler' is the last name, the `StrdNm.LastNm` value must be 'Iglesias Preysler'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm2": {
"description": "Secondary last name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"NtrlNm": {
"description": "Name in local character set or language.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Title": {
"description": "Title by which the party is known and which is usually used to identify the party.",
"type": "string",
"minLength": 1,
"maxLength": 20
}
}
}
}
}
}
},
"PrvtId": {
"type": "object",
"description": "Unique and unambiguous identification of a person, e.g., passport.",
"properties": {
"DtAndPlcOfBirth": {
"type": "object",
"description": "Date and place of birth of a person.",
"properties": {
"BirthDt": {
"description": "Information that identifies the date of Birth for the party.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"PrvcOfBirth": {
"description": "Information that locates and identifies the Province of birth for the party.",
"type": "string",
"maxLength": 35
},
"CityOfBirth": {
"description": "Information that locates and identifies the city of birth for the party.",
"type": "string",
"maxLength": 35
},
"CtryOfBirth": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country of birth for the party, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list."
}
}
},
"Othr": {
"type": "array",
"description": "An array of objects, each containing the unique identification of a party, as assigned by an institution, using an identification scheme.",
"items": {
"type": "object",
"properties": {
"Id": {
"description": "Value to be used to identify the party",
"type": "string",
"maxLength": 35
},
"Issr": {
"description": "Information for the Entity that assigns the identification.",
"type": "string",
"maxLength": 35
},
"SchmeNm": {
"type": "object",
"description": "Name of the identification scheme used to identify an individual.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ISO20022 ExternalPersonIdentification1Code List ",
"enum": [
"ARNU",
"CCPT",
"CUST",
"DRLC",
"EMPL",
"NIDN",
"SOS",
"TELE",
"TXID"
],
"x-enumDescriptions": {
"ARNU": "Alien Registration Number",
"CCPT": "Passport Number",
"CUST": "Customer Identification Number",
"DRLC": "Drivers License Number",
"EMPL": "Employee Identification Number",
"NIDN": "National Identity Number",
"SOS": "Social Security Number",
"TELE": "Telephone Number",
"TXID": "Tax Identification Number"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"DtOfIss": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Issue date of the supporting documentation.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"DtOfXpry": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Expiration date of the supporting documentation.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"MrzNb": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Machine Readable Zone for Passport. This field only applies if the ID is a passport.",
"type": "string",
"maxLength": 88,
"pattern": "^[A-Z<]{1}[A-Z0-9<]{1}[A-Z<]{3}[0-9<]{6}[A0-9<]{1}[0-9<]{1}[A0-9<]{7}[A-Z<]{1}[0-9<]{1}[0-9<]{3}[A0-9<]{1}[0-9<]{1}[A0-9<]{7}[0-9<]{14}$"
}
}
}
},
"Gndr": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Information that captures the Gender of a party.",
"type": "string",
"maxLength": 6,
"enum": [
"Male",
"Female",
"Other"
],
"x-enumDescriptions": {
"Male": "Male",
"Female": "Female",
"Other": "Other"
}
},
"Prfssn": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Information that captures the occupation of a party.",
"type": "string",
"maxLength": 35
},
"RelShipToCdtr": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Relationship of the receiving party to the sending party.<br/><strong>Note</strong>: This information is required within the creditor object `cdtr` for payout in the Philippines.",
"type": "string",
"enum": [
"CHIL",
"CUST",
"EMPL",
"EXSP",
"FREN",
"OTHR",
"PARE",
"PART",
"RELA",
"SELF",
"SIBL",
"SPOU",
"VEND"
],
"x-enumDescriptions": {
"CHIL": "Child",
"CUST": "Customer",
"EMPL": "Employee",
"EXSP": "Ex-spouse",
"FREN": "Friend",
"OTHR": "Other",
"PARE": "Parent",
"PART": "Business partner",
"RELA": "Relation",
"SELF": "Self",
"SIBL": "Sibling",
"SPOU": "Covering Spouse/Partner",
"VEND": "Vendor"
}
},
"Ntlty": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "ISO Country Code of nationality of the party.<br/><br/>Deprecated in favor of `UltmtDbtr.PrvtId.Ctznsh.Ntlty`",
"maxLength": 3,
"deprecated": {
"description": "Deprecated in favor of `UltmtDbtr.PrvtId.Ctznsh.Ntlty`",
"deprecatedVersion": "1.1"
}
},
"Residence": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "ISO Country Code of residence of the party.<br/><br/>Deprecated: Must be served by `UltmtDbtr.CtryOfRes`",
"maxLength": 3,
"deprecated": {
"description": "Must be served by `UltmtDbtr.CtryOfRes`.",
"deprecatedVersion": "As per latest ISO 20022 PACS.008 standard."
}
},
"Ctznsh": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Describes the citizenship.",
"properties": {
"Ntlty": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Nationality of the party. Use ISO Country Code for values.",
"maxLength": 3
},
"MnrId": {
"description": "Indicates whether the party is a minor.",
"type": "string",
"enum": [
"YES",
"NO"
],
"x-enumDescriptions": {
"YES": "Party is a minor.",
"NO": "Party is not a minor."
}
},
"StartDt": {
"description": "Start date of citizenship for the party.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"EndDt": {
"description": "End date of citizenship for the party.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
}
}
}
}
}
}
},
"CtctDtls": {
"type": "object",
"description": "Allows the contact of the Debtor to be held.",
"properties": {
"NmPrfx": {
"type": "string",
"description": "List based on ISO 20022 NamePrefix1Code List",
"enum": [
"DOCT",
"MIST",
"MISS",
"MADM"
],
"x-enumDescriptions": {
"DOCT": "Doctor",
"MIST": "Mister",
"MISS": "Miss",
"MADM": "Madam"
}
},
"Nm": {
"type": "string",
"description": "Name by which a party is known and which is usually used to identify that party.",
"maxLength": 140
},
"PhneNb": {
"type": "string",
"description": "Phone Number",
"maxLength": 15,
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"MobNb": {
"type": "string",
"description": "Mobile Phone Number",
"maxLength": 15,
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"FaxNb": {
"type": "string",
"description": "Fax Number",
"maxLength": 15,
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"EmailAdr": {
"type": "string",
"description": "Address for electronic mail (e-mail).",
"format": "email",
"maxLength": 2048
},
"Othr": {
"type": "string",
"description": "Contact details in another form.",
"maxLength": 35
}
}
}
}
},
"DbtrAcct": {
"type": "object",
"title": "Debtor Account Information",
"description": "Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.",
"properties": {
"Nm": {
"type": "string",
"description": "Name by which the account is known and which is usually used to identify the Debtor account.",
"maxLength": 140
},
"Ccy": {
"type": "string",
"description": "Currency for the Debtor Account",
"pattern": "^[A-Z]{3,3}$"
},
"Id": {
"type": "object",
"description": "Nature or use of the Debtor account.",
"properties": {
"IBAN": {
"type": "string",
"pattern": "^([a-zA-Z0-9_-]){15,35}$",
"description": "Holds the Debtor account number in International Bank Account Number (IBAN) format.<br/><br/><b>Usage Guidelines</b>:<br/><li>If you specify `IBAN`, do not specify `Othr.Id`.<li>This field is used in conjunction with `DbtrAgt.FinInstnId.BICFI`<li>Example IBAN: `GB29NWBK60161331926819`."
},
"Othr": {
"type": "object",
"properties": {
"Id": {
"description": "Holds the Debtor account number in non-IBAN format.<br/><br/><b>Usage Guidelines</b><ul><li>If you specify `Othr.Id`, do not specify `IBAN`.<li>Specify `NOTPROVIDED` if no information is available about the Debtor's paying instrument (for example, a cash payment), or if this information is being withheld for compliance, regulatory, or privacy reasons.<ul><li>Do not use this string if Debtor information is available and can be specified.</ul><li>Example non-IBAN string: `31926819`.",
"type": "string",
"maxLength": 34
},
"SchmeNm": {
"type": "object",
"description": "Name of the account identification scheme.",
"properties": {
"Cd": {
"type": "string",
"description": "Identifier of an account, as assigned by the account servicer, list based on a combination of ExternalAccountIdentification1Code and AccountIdentification30Choice ISO 20022 Lists. For more information, see [ExternalCodeSets2Q2020August2020](https://www.iso20022.org/sites/default/files/2020-08/ExternalCodeSets_2Q2020_August2020_v1.xlsx).<br/><br/><b>Usage Guidelines</b>:<br/><li>Do not specify `Othr.SchmeNm.Cd` if you do not specify `Othr.Id`.</li><br/><b>Examples values</b><br/><li>Bank account transfer: `BBAN`<li>Cash payout</b>: `CASH`",
"minItems": 1,
"maxItems": 1,
"enum": [
"AIIN",
"BBAN",
"CARD",
"CASH",
"CASHD2D",
"CUID",
"UPIC",
"EMail",
"MSISDN",
"Dmst",
"Other"
],
"x-enumDescriptions": {
"AIIN": "Issuer Identification Number",
"BBAN": "Basic Bank Account Number",
"CARD": "PAN of the Card identifying the account",
"CASH": "Cash Payments",
"CASHD2D": "Cash door-to-door delivery",
"CUID": "CHIPS Universal Identifier",
"UPIC": "Universal Payment Indentification Code",
"EMail": "Email Address",
"MSISDN": "Mobile Subscriber Integrated Service Digital Network, (i.e. mobile phone number of the SIM card).",
"Dmst": "Domestic",
"Other": "Other Identifier"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"Issr": {
"type": "string",
"description": "Entity that assigns the identification.",
"maxLength": 35
}
},
"required": [
"Id"
]
}
}
},
"Tp": {
"type": "object",
"description": "Nature or use of the Debtor account.",
"properties": {
"Cd": {
"type": "string",
"description": "Type of external cash account. The list is based on ISO20022 ExternalCashAccountType1Code List [27-Aug-2021](https://www.iso20022.org/sites/default/files/2021-08/ExternalCodeSets_2Q2021.xlsx). ",
"minItems": 1,
"maxItems": 1,
"enum": [
"CACC",
"CARD",
"CASH",
"CHAR",
"CISH",
"COMM",
"CPAC",
"LLSV",
"LOAN",
"MGLD",
"MOMA",
"NREX",
"ODFT",
"ONDP",
"OTHR",
"SACC",
"SLRY",
"SVGS",
"TAXE",
"TRAN",
"TRAS"
],
"x-enumDescriptions": {
"CACC": "Account used to post debits and credits when no specific account has been nominated.",
"CARD": "Card Account.",
"CASH": "Account used for the payment of cash.",
"CHAR": "Account used for charges if different from the account for payment.",
"CISH": "Account used for payment of income if different from the current cash account.",
"COMM": "Account used for commission if different from the account for payment.",
"CPAC": "Account used to post settlement debit and credit entries on behalf of a designated Clearing Participant.",
"LLSV": "Account used for savings with special interest and withdrawal terms.",
"LOAN": "Account used for loans.",
"MGLD": "Account used for a marginal lending facility.",
"MOMA": "Account used for money markets if different from the cash account.",
"NREX": "Account used for non-resident external.",
"ODFT": "Account is used for overdrafts.",
"ONDP": "Account used for overnight deposits.",
"OTHR": "Account not otherwise specified.",
"SACC": "Account used to post debit and credit entires, as a result of transactions cleared and settled through a specific clearing and settlement system.",
"SLRY": "Account used for salary payments.",
"SVGS": "Account used for savings.",
"TAXE": "Account used for taxes if different from the account for payment.",
"TRAN": "A transacting account is the most basic type of bank account that you can get. The main difference between transaction and check accounts is that you usually do not get a check book with your transacting account and neither are you offered an overdraft facility.",
"TRAS": "Account used for trading if different from the current cash account."
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
}
},
"required": [
"Id"
]
},
"DbtrAgt": {
"type": "object",
"title": "Debtor Agent Information",
"description": "Financial institution servicing an account for the debtor.",
"properties": {
"FinInstnId": {
"type": "object",
"description": "Allows the details of the Debtor Agent to be held",
"properties": {
"BICFI": {
"type": "string",
"pattern": "^([a-zA-Z0-9_-]){8,11}$",
"description": "The Business identifier code (BIC) allocated to a receiving institution by the [ISO 9362 Registration Authority](https://www.iso.org/standard/84108.html).<br/><br/><b>Usage Guidelines</b>:<br/><li>If you specify BICFI, do not specify `ClrSysMmbId.MmbId`.<li>Use this property in conjunction with `DbtrAcct.Id.IBAN`.<li>The string must be either 8 or 11 characters long.<br/><br/><b>Example</b>: `BANKGB22`"
},
"Nm": {
"description": "Name by which the party is known and which is usually used to identify the party.<br/><ul><li>Must include one (1) name string.<li>Allowable characters: Alphanumeric and space.<li>Names with multiple words must be separated by a space.<li>For example, specify \"Widgets Org\", as `Widgets Org`.<li>Provide a truncated name if longer than 140 characters.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 140
},
"ClrSysMmbId": {
"type": "object",
"description": "Information used to identify a member within a clearing system.",
"required": [
"MmbId"
],
"properties": {
"MmbId": {
"description": "Contains the routing code / sort code for the institution<br/><br/><b>Usage Guidelines</b>:<li>If you specify `ClrSysMmbId.MmbId`, do not specify BICFI.<li>Use this property in conjunction with `DbtrAcct.Id.Othr.Id`.<li>For cash payouts, specify the ID of the agent facilitating the payout.<li>For mobile or e-wallet transfers where the wallet issuer is a non-banking entity, specify the ID of the wallet issuer.<br/><br/><b>Examples</b><li>Example non-cash payout: `37040044`<li>Example cash payout: `Jollibee`",
"type": "string",
"maxLength": 35
},
"ClrSysId": {
"type": "object",
"description": "Information used to identify a member within a clearing system.",
"properties": {
"Cd": {
"type": "string",
"description": "Code identifying the external clearing system. List based on the [27-Aug-2021](https://www.iso20022.org/sites/default/files/2021-08/ExternalCodeSets_2Q2021.xlsx) ISO 20022 ExternalClearingSystemIdentification1Code List.<br/><br/><b>Usage Guidelines</b>:<li>Do not specify `ClrSysMmbId.ClrSysId.Cd` if you do not specify `ClrSysMmbId.MmbId`.<br/><br/><b>Examples</b><li>For cash payouts, specify `NOREQ`.<li>Example of a valid clearing system code is `DEBLZ`.",
"minItems": 1,
"maxItems": 1,
"enum": [
"ATBLZ",
"AUBSB",
"BEFTN",
"CACPA",
"CHBCC",
"CHSIC",
"CNAPS",
"DEBLZ",
"ESNCC",
"GBDSC",
"GRBIC",
"HKNCC",
"IENCC",
"INFSC",
"ITNCC",
"JPZGN",
"NGBCS",
"NZNCC",
"PLKNR",
"PTNCC",
"RUCBC",
"SESBA",
"SGIBG",
"SLCFT",
"THCBC",
"TWNCC",
"USABA",
"USPID",
"ZANCC"
],
"x-enumDescriptions": {
"ATBLZ": "Austrian Bankleitzahl, Bank Branch code used in Austria",
"AUBSB": "Australian Bank State Branch Code (BSB), Bank Branch code used in Australia",
"BEFTN": "Bangladesh Electronic Funds Transfer Network, domestic clearing system used in Bangladesh",
"CACPA": "Canadian Payments Association Payment Routing Number, Bank Branch code used in Canada",
"CHBCC": "Swiss Financial Institution Identification (short), Financial Institution Identification (IID) used in Switzerland, without check digit",
"CHSIC": "Swiss Financial Institution Identification (long), Financial Institution Identification (IID) used in Switzerland, including check digit",
"CNAPS": "CNAPS Identifier, Bank Branch code used in China",
"DEBLZ": "German Bankleitzahl, Bank Branch code used in Germany",
"ESNCC": "Spanish Domestic Interbanking Code, Bank Branch code used in Spain",
"GBDSC": "UK Domestic Sort Code, Bank Branch code used in the UK",
"GRBIC": "Helenic Bank Identification Code, Bank Branch code used in Greece",
"HKNCC": "Hong Kong Bank Code, Bank Branch code used in Hong Kong",
"IENCC": "Irish National Clearing Code, Bank Branch code used in Ireland",
"INFSC": "Indian Financial System Code, Bank Branch code used in India",
"ITNCC": "Italian Domestic Identification Code, Bank Branch code used in Italy",
"JPZGN": "Japan Zengin Clearing Code, Bank Branch code used in Japan",
"NGBCS": "Nigerian Bank Clearing System, identifies the Nigerian Domestic System",
"NZNCC": "New Zealand National Clearing Code, Bank Branch code used in New Zealand",
"PLKNR": "Polish National Clearing Code, Bank Branch code used in Poland",
"PTNCC": "Portuguese National Clearing Code, Bank Branch code used in Portugal",
"RUCBC": "Russian Central Bank Identification Code, Bank Branch code used in Russia",
"SESBA": "Sweden Bankgiro Clearing Code, Bank Branch code used in Sweden",
"SGIBG": "IBG Sort Code, Bank Branch code used in Singapore",
"SLCFT": "Sri Lankan Domestic System, Bank Identification code used in Sri Lanka",
"THCBC": "Thai Central Bank Identification Code, Bank Identification code used in Thailand",
"TWNCC": "Financial Institution Code, Bank Branch code used in Taiwan",
"USABA": "United States Routing Number (Fedwire, NACHA), Routing Transit number assigned by the ABA for US financial institutons",
"USPID": "CHIPS Participant Identifier, Bank identifier used by CHIPs in the US",
"ZANCC": "South African National Clearing Code, Bank Branch code used in South Africa"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
}
}
},
"PstlAdr": {
"type": "object",
"description": "Address for the party or organization.",
"properties": {
"AdrTp": {
"type": "string",
"description": "Specifies the type of address based on the [ISO20022 AddressType1Code](https://www.iso20022.org/standardsrepository/type/AddressType1Code) list",
"minItems": 1,
"maxItems": 1,
"enum": [
"ADDR",
"PBOX",
"HOME",
"BIZZ",
"MLTO",
"DLVY"
],
"x-enumDescriptions": {
"ADDR": "Postal",
"PBOX": "PO Box",
"HOME": "Residential",
"BIZZ": "Business",
"MLTO": "Mail To",
"DLVY": "Delivery To"
}
},
"AdrLine": {
"description": "Information that locates and identifies the address for the party.",
"type": "array",
"maxLength": 70
},
"Dept": {
"description": "Information that locates and identifies the department for the party.",
"type": "string",
"maxLength": 70
},
"SubDept": {
"description": "Information that locates and identifies the sub department for the party.",
"type": "string",
"maxLength": 70
},
"StrtNm": {
"description": "Information that locates and identifies the street name for the party, as defined by postal services.",
"type": "string",
"maxLength": 70
},
"BldgNb": {
"description": "Information that locates and identifies the building number for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"PstCd": {
"description": "Information that locates and identifies postal code for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"TwnNm": {
"description": "Information that locates and identifies the city / town for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"CtrySubDvsn": {
"description": "Information that locates and identifies the state / county for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"Ctry": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country for the party, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list."
}
}
},
"Othr": {
"type": "object",
"description": "Unique identification of an agent, as assigned by an institution, using an identification scheme.",
"properties": {
"Id": {
"type": "string",
"description": "Unique and unambiguous identification of a person."
},
"SchmeNm": {
"type": "object",
"description": "Name of the agent identification scheme.",
"properties": {
"Cd": {
"type": "string",
"description": "Based on list for externalfinancialinstitution1code defined by ISO 20022"
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"Issr": {
"type": "string",
"description": "Entity that assigns the identification.",
"maxLength": 35
}
}
}
}
},
"BrnchId": {
"type": "object",
"description": "Allows the details of the Debtor Agent Branch to be held",
"properties": {
"Id": {
"type": "string",
"description": "Unique and unambiguous identification of a branch of a financial institution.",
"maxLength": 35
},
"Nm": {
"type": "string",
"description": "Name for the Branch. <br/><ul><li>Must include one (1) name string.<li>Allowable characters: Alphanumeric and space.<li>Names with multiple words must be separated by a space.<li>For example, specify \"Widgets Org\", as `Widgets Org`.<li>Provide a truncated name if longer than 140 characters.",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 140
},
"PstlAdr": {
"type": "object",
"description": "Address for the Branch",
"properties": {
"AdrTp": {
"type": "string",
"description": "Specifies the type of address based on the [ISO20022 AddressType1Code](https://www.iso20022.org/standardsrepository/type/AddressType1Code) list",
"minItems": 1,
"maxItems": 1,
"enum": [
"ADDR",
"PBOX",
"HOME",
"BIZZ",
"MLTO",
"DLVY"
],
"x-enumDescriptions": {
"ADDR": "Postal",
"PBOX": "PO Box",
"HOME": "Residential",
"BIZZ": "Business",
"MLTO": "Mail To",
"DLVY": "Delivery To"
}
},
"AdrLine": {
"description": "Information that locates and identifies the address for the party.",
"type": "array",
"maxLength": 70
},
"Dept": {
"description": "Information that locates and identifies the department for the party.",
"type": "string",
"maxLength": 70
},
"SubDept": {
"description": "Information that locates and identifies the sub department for the party.",
"type": "string",
"maxLength": 70
},
"StrtNm": {
"description": "Information that locates and identifies the street name for the party, as defined by postal services.",
"type": "string",
"maxLength": 70
},
"BldgNb": {
"description": "Information that locates and identifies the building number for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"PstCd": {
"description": "Information that locates and identifies postal code for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"TwnNm": {
"description": "Information that locates and identifies the city / town for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"CtrySubDvsn": {
"description": "Information that locates and identifies the state / county for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"Ctry": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country for the party, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list."
}
}
}
}
}
}
},
"DbtrAgtAcct": {
"type": "object",
"title": "Debtor Agent Account Information",
"description": "Unambiguous identification of the account of the debtor agent at its servicing agent in the payment chain.<br/><br/><b>Note</b>: In most instances, partners do need not to use `DbtrAgtAcct`, unless the field is mandated within a community or bilaterally agreed upon (e.g., Mexico).",
"properties": {
"Id": {
"type": "object",
"description": "Unique and unambiguous identification for the account between the account owner and the account servicer.",
"properties": {
"IBAN": {
"type": "string",
"pattern": "^([a-zA-Z0-9_-]){15,35}$",
"description": "International Bank Account Number (IBAN) for the account.<br/><br/><b>Usage Guidelines</b>:<br/>If you specify `IBAN`, do not specify `Othr.Id`.<li>Example IBAN: `GB29NWBK60161331926819`."
},
"Othr": {
"type": "object",
"properties": {
"Id": {
"description": "Identification assigned by an institution.",
"type": "string",
"maxLength": 34
},
"SchmeNm": {
"type": "object",
"description": "Name of the account identification scheme.",
"properties": {
"Cd": {
"type": "string",
"description": "Identifier of an account, as assigned by the account servicer, list based on a combination of ExternalAccountIdentification1Code and AccountIdentification30Choice ISO 20022 Lists. For more information, see [ExternalCodeSets2Q2020August2020](https://www.iso20022.org/sites/default/files/2020-08/ExternalCodeSets_2Q2020_August2020_v1.xlsx).<br/><br/><b>Usage Guidelines</b>:<br/><li>Do not specify `Othr.SchmeNm.Cd` if you do not specify `Othr.Id`.</li><br/><b>Examples values</b><br/><li>Bank account transfer: `BBAN`<li>Cash payout</b>: `CASH`",
"minItems": 1,
"maxItems": 1,
"enum": [
"AIIN",
"BBAN",
"CARD",
"CASH",
"CASHD2D",
"CUID",
"UPIC",
"EMail",
"MSISDN",
"Dmst",
"Other"
],
"x-enumDescriptions": {
"AIIN": "Issuer Identification Number",
"BBAN": "Basic Bank Account Number",
"CARD": "PAN of the Card identifying the account",
"CASH": "Cash Payments",
"CASHD2D": "Cash door-to-door delivery",
"CUID": "CHIPS Universal Identifier",
"UPIC": "Universal Payment Indentification Code",
"EMail": "Email Address",
"MSISDN": "Mobile Subscriber Integrated Service Digital Network, (i.e. mobile phone number of the SIM card).",
"Dmst": "Domestic",
"Other": "Other Identifier"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"Issr": {
"type": "string",
"description": "Entity that assigns the identification.",
"maxLength": 35
}
}
}
}
},
"Tp": {
"type": "object",
"description": "Nature or use of the account.",
"properties": {
"Cd": {
"type": "string",
"description": "Type of external cash account. The list is based on ISO20022 ExternalCashAccountType1Code List [27-Aug-2021](https://www.iso20022.org/sites/default/files/2021-08/ExternalCodeSets_2Q2021.xlsx). ",
"minItems": 1,
"maxItems": 1,
"enum": [
"CACC",
"CARD",
"CASH",
"CHAR",
"CISH",
"COMM",
"CPAC",
"LLSV",
"LOAN",
"MGLD",
"MOMA",
"NREX",
"ODFT",
"ONDP",
"OTHR",
"SACC",
"SLRY",
"SVGS",
"TAXE",
"TRAN",
"TRAS"
],
"x-enumDescriptions": {
"CACC": "Account used to post debits and credits when no specific account has been nominated.",
"CARD": "Card Account.",
"CASH": "Account used for the payment of cash.",
"CHAR": "Account used for charges if different from the account for payment.",
"CISH": "Account used for payment of income if different from the current cash account.",
"COMM": "Account used for commission if different from the account for payment.",
"CPAC": "Account used to post settlement debit and credit entries on behalf of a designated Clearing Participant.",
"LLSV": "Account used for savings with special interest and withdrawal terms.",
"LOAN": "Account used for loans.",
"MGLD": "Account used for a marginal lending facility.",
"MOMA": "Account used for money markets if different from the cash account.",
"NREX": "Account used for non-resident external.",
"ODFT": "Account is used for overdrafts.",
"ONDP": "Account used for overnight deposits.",
"OTHR": "Account not otherwise specified.",
"SACC": "Account used to post debit and credit entires, as a result of transactions cleared and settled through a specific clearing and settlement system.",
"SLRY": "Account used for salary payments.",
"SVGS": "Account used for savings.",
"TAXE": "Account used for taxes if different from the account for payment.",
"TRAN": "A transacting account is the most basic type of bank account that you can get. The main difference between transaction and check accounts is that you usually do not get a check book with your transacting account and neither are you offered an overdraft facility.",
"TRAS": "Account used for trading if different from the current cash account."
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"Ccy": {
"type": "string",
"description": "Code allocated to identify a currency for the Debtor Agent Account. Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.",
"pattern": "^[A-Z]{3,3}$"
},
"Nm": {
"type": "string",
"description": "Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.<br/><br/>The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.",
"maxLength": 140
},
"Prxy": {
"type": "object",
"description": "Specifies an alternate assumed name for the identification of the account.",
"properties": {
"Id": {
"type": "object",
"description": "Unique and unambiguous identification for the account between the account owner and the account servicer.",
"properties": {
"IBAN": {
"type": "string",
"pattern": "^([a-zA-Z0-9_-]){15,35}$",
"description": "International Bank Account Number (IBAN) for the account.<br/><br/><b>Usage Guidelines</b>:<br/>If you specify `IBAN`, do not specify `Othr.Id`.<li>Example IBAN: `GB29NWBK60161331926819`."
},
"Othr": {
"type": "object",
"properties": {
"Id": {
"description": "Identification assigned by an institution.",
"type": "string",
"maxLength": 34
},
"SchmeNm": {
"type": "object",
"description": "Name of the account identification scheme.",
"properties": {
"Cd": {
"type": "string",
"description": "Identifier of an account, as assigned by the account servicer, list based on a combination of ExternalAccountIdentification1Code and AccountIdentification30Choice ISO 20022 Lists. For more information, see [ExternalCodeSets2Q2020August2020](https://www.iso20022.org/sites/default/files/2020-08/ExternalCodeSets_2Q2020_August2020_v1.xlsx).<br/><br/><b>Usage Guidelines</b>:<br/><li>Do not specify `Othr.SchmeNm.Cd` if you do not specify `Othr.Id`.</li><br/><b>Examples values</b><br/><li>Bank account transfer: `BBAN`<li>Cash payout</b>: `CASH`",
"minItems": 1,
"maxItems": 1,
"enum": [
"AIIN",
"BBAN",
"CARD",
"CASH",
"CASHD2D",
"CUID",
"UPIC",
"EMail",
"MSISDN",
"Dmst",
"Other"
],
"x-enumDescriptions": {
"AIIN": "Issuer Identification Number",
"BBAN": "Basic Bank Account Number",
"CARD": "PAN of the Card identifying the account",
"CASH": "Cash Payments",
"CASHD2D": "Cash door-to-door delivery",
"CUID": "CHIPS Universal Identifier",
"UPIC": "Universal Payment Indentification Code",
"EMail": "Email Address",
"MSISDN": "Mobile Subscriber Integrated Service Digital Network, (i.e. mobile phone number of the SIM card).",
"Dmst": "Domestic",
"Other": "Other Identifier"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"Issr": {
"type": "string",
"description": "Entity that assigns the identification.",
"maxLength": 35
}
}
}
}
},
"Tp": {
"type": "object",
"description": "Nature or use of the account.",
"properties": {
"Cd": {
"type": "string",
"description": "Type of external cash account. The list is based on ISO20022 ExternalCashAccountType1Code List [27-Aug-2021](https://www.iso20022.org/sites/default/files/2021-08/ExternalCodeSets_2Q2021.xlsx). ",
"minItems": 1,
"maxItems": 1,
"enum": [
"CACC",
"CARD",
"CASH",
"CHAR",
"CISH",
"COMM",
"CPAC",
"LLSV",
"LOAN",
"MGLD",
"MOMA",
"NREX",
"ODFT",
"ONDP",
"OTHR",
"SACC",
"SLRY",
"SVGS",
"TAXE",
"TRAN",
"TRAS"
],
"x-enumDescriptions": {
"CACC": "Account used to post debits and credits when no specific account has been nominated.",
"CARD": "Card Account.",
"CASH": "Account used for the payment of cash.",
"CHAR": "Account used for charges if different from the account for payment.",
"CISH": "Account used for payment of income if different from the current cash account.",
"COMM": "Account used for commission if different from the account for payment.",
"CPAC": "Account used to post settlement debit and credit entries on behalf of a designated Clearing Participant.",
"LLSV": "Account used for savings with special interest and withdrawal terms.",
"LOAN": "Account used for loans.",
"MGLD": "Account used for a marginal lending facility.",
"MOMA": "Account used for money markets if different from the cash account.",
"NREX": "Account used for non-resident external.",
"ODFT": "Account is used for overdrafts.",
"ONDP": "Account used for overnight deposits.",
"OTHR": "Account not otherwise specified.",
"SACC": "Account used to post debit and credit entires, as a result of transactions cleared and settled through a specific clearing and settlement system.",
"SLRY": "Account used for salary payments.",
"SVGS": "Account used for savings.",
"TAXE": "Account used for taxes if different from the account for payment.",
"TRAN": "A transacting account is the most basic type of bank account that you can get. The main difference between transaction and check accounts is that you usually do not get a check book with your transacting account and neither are you offered an overdraft facility.",
"TRAS": "Account used for trading if different from the current cash account."
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
}
}
}
}
},
"CdtrAgt": {
"type": "object",
"title": "Creditor Agent",
"description": "Financial institution servicing an account for the creditor.",
"properties": {
"FinInstnId": {
"type": "object",
"description": "Allows the details of the Creditor Agent to be held",
"properties": {
"BICFI": {
"type": "string",
"pattern": "^([a-zA-Z0-9_-]){8,11}$",
"description": "The Business identifier code (BIC) allocated to a receiving institution by the [ISO 9362 Registration Authority](https://www.iso.org/standard/84108.html).<br/><br/><b>Usage Guidelines</b>:<br/><li>If you specify BICFI, do not specify `ClrSysMmbId.MmbId`.<li>Use this property in conjunction with `CdtrAcct.Id.IBAN`.<li>The string must be either 8 or 11 characters long.<br/><br/><b>Example</b>: `BANKGB22`"
},
"Nm": {
"description": "Name by which the party is known and which is usually used to identify the party.<br/><ul><li>Must include one (1) name string.<li>Allowable characters: Alphanumeric and space.<li>Names with multiple words must be separated by a space.<li>For example, specify \"Widgets Org\", as `Widgets Org`.<li>Provide a truncated name if longer than 140 characters.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 140
},
"ClrSysMmbId": {
"type": "object",
"description": "Information used to identify a member within a clearing system.",
"required": [
"MmbId"
],
"properties": {
"MmbId": {
"description": "Contains the routing code / sort code for the institution<br/><br/><b>Usage Guidelines</b>:<li>If you specify `ClrSysMmbId.MmbId`, do not specify BICFI.<li>Use this property in conjunction with `CdtrAcct.Id.Othr.Id`.<li>For cash payouts, specify the ID of the agent facilitating the payout.<li>For mobile or e-wallet transfers where the wallet issuer is a non-banking entity, specify the ID of the wallet issuer.<br/><br/><b>Examples</b><li>Example non-cash payout: `37040044`<li>Example cash payout: `Jollibee`",
"type": "string",
"maxLength": 35
},
"ClrSysId": {
"type": "object",
"description": "Information used to identify a member within a clearing system.",
"properties": {
"Cd": {
"type": "string",
"description": "Code identifying the external clearing system. List based on the [27-Aug-2021](https://www.iso20022.org/sites/default/files/2021-08/ExternalCodeSets_2Q2021.xlsx) ISO 20022 ExternalClearingSystemIdentification1Code List.<br/><br/><b>Usage Guidelines</b>:<li>Do not specify `ClrSysMmbId.ClrSysId.Cd` if you do not specify `ClrSysMmbId.MmbId`.<br/><br/><b>Examples</b><li>For cash payouts, specify `NOREQ`.<li>Example of a valid clearing system code is `DEBLZ`.",
"minItems": 1,
"maxItems": 1,
"enum": [
"ATBLZ",
"AUBSB",
"BEFTN",
"CACPA",
"CHBCC",
"CHSIC",
"CNAPS",
"DEBLZ",
"ESNCC",
"GBDSC",
"GRBIC",
"HKNCC",
"IENCC",
"INFSC",
"ITNCC",
"JPZGN",
"NGBCS",
"NZNCC",
"PLKNR",
"PTNCC",
"RUCBC",
"SESBA",
"SGIBG",
"SLCFT",
"THCBC",
"TWNCC",
"USABA",
"USPID",
"ZANCC"
],
"x-enumDescriptions": {
"ATBLZ": "Austrian Bankleitzahl, Bank Branch code used in Austria",
"AUBSB": "Australian Bank State Branch Code (BSB), Bank Branch code used in Australia",
"BEFTN": "Bangladesh Electronic Funds Transfer Network, domestic clearing system used in Bangladesh",
"CACPA": "Canadian Payments Association Payment Routing Number, Bank Branch code used in Canada",
"CHBCC": "Swiss Financial Institution Identification (short), Financial Institution Identification (IID) used in Switzerland, without check digit",
"CHSIC": "Swiss Financial Institution Identification (long), Financial Institution Identification (IID) used in Switzerland, including check digit",
"CNAPS": "CNAPS Identifier, Bank Branch code used in China",
"DEBLZ": "German Bankleitzahl, Bank Branch code used in Germany",
"ESNCC": "Spanish Domestic Interbanking Code, Bank Branch code used in Spain",
"GBDSC": "UK Domestic Sort Code, Bank Branch code used in the UK",
"GRBIC": "Helenic Bank Identification Code, Bank Branch code used in Greece",
"HKNCC": "Hong Kong Bank Code, Bank Branch code used in Hong Kong",
"IENCC": "Irish National Clearing Code, Bank Branch code used in Ireland",
"INFSC": "Indian Financial System Code, Bank Branch code used in India",
"ITNCC": "Italian Domestic Identification Code, Bank Branch code used in Italy",
"JPZGN": "Japan Zengin Clearing Code, Bank Branch code used in Japan",
"NGBCS": "Nigerian Bank Clearing System, identifies the Nigerian Domestic System",
"NZNCC": "New Zealand National Clearing Code, Bank Branch code used in New Zealand",
"PLKNR": "Polish National Clearing Code, Bank Branch code used in Poland",
"PTNCC": "Portuguese National Clearing Code, Bank Branch code used in Portugal",
"RUCBC": "Russian Central Bank Identification Code, Bank Branch code used in Russia",
"SESBA": "Sweden Bankgiro Clearing Code, Bank Branch code used in Sweden",
"SGIBG": "IBG Sort Code, Bank Branch code used in Singapore",
"SLCFT": "Sri Lankan Domestic System, Bank Identification code used in Sri Lanka",
"THCBC": "Thai Central Bank Identification Code, Bank Identification code used in Thailand",
"TWNCC": "Financial Institution Code, Bank Branch code used in Taiwan",
"USABA": "United States Routing Number (Fedwire, NACHA), Routing Transit number assigned by the ABA for US financial institutons",
"USPID": "CHIPS Participant Identifier, Bank identifier used by CHIPs in the US",
"ZANCC": "South African National Clearing Code, Bank Branch code used in South Africa"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
}
}
},
"PstlAdr": {
"type": "object",
"description": "Address for the party or organization.",
"properties": {
"AdrTp": {
"type": "string",
"description": "Specifies the type of address based on the [ISO20022 AddressType1Code](https://www.iso20022.org/standardsrepository/type/AddressType1Code) list",
"minItems": 1,
"maxItems": 1,
"enum": [
"ADDR",
"PBOX",
"HOME",
"BIZZ",
"MLTO",
"DLVY"
],
"x-enumDescriptions": {
"ADDR": "Postal",
"PBOX": "PO Box",
"HOME": "Residential",
"BIZZ": "Business",
"MLTO": "Mail To",
"DLVY": "Delivery To"
}
},
"AdrLine": {
"description": "Information that locates and identifies the address for the party.",
"type": "array",
"maxLength": 70
},
"Dept": {
"description": "Information that locates and identifies the department for the party.",
"type": "string",
"maxLength": 70
},
"SubDept": {
"description": "Information that locates and identifies the sub department for the party.",
"type": "string",
"maxLength": 70
},
"StrtNm": {
"description": "Information that locates and identifies the street name for the party, as defined by postal services.",
"type": "string",
"maxLength": 70
},
"BldgNb": {
"description": "Information that locates and identifies the building number for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"PstCd": {
"description": "Information that locates and identifies postal code for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"TwnNm": {
"description": "Information that locates and identifies the city / town for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"CtrySubDvsn": {
"description": "Information that locates and identifies the state / county for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"Ctry": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country for the party, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list."
}
}
},
"Othr": {
"type": "object",
"description": "Unique identification of an agent, as assigned by an institution, using an identification scheme.",
"properties": {
"Id": {
"type": "string",
"description": "Unique and unambiguous identification of a person."
},
"SchmeNm": {
"type": "object",
"description": "Name of the agent identification scheme.",
"properties": {
"Cd": {
"type": "string",
"description": "Based on list for externalfinancialinstitution1code defined by ISO 20022"
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"Issr": {
"type": "string",
"description": "Entity that assigns the identification.",
"maxLength": 35
}
}
}
}
},
"BrnchId": {
"type": "object",
"description": "Allows the details of the Creditor Agent Branch to be held",
"properties": {
"Id": {
"type": "string",
"description": "Unique and unambiguous identification of a branch of a financial institution.",
"maxLength": 35
},
"Nm": {
"type": "string",
"description": "Name for the Branch. <br/><ul><li>Must include one (1) name string.<li>Allowable characters: Alphanumeric and space.<li>Names with multiple words must be separated by a space.<li>For example, specify \"Widgets Org\", as `Widgets Org`.<li>Provide a truncated name if longer than 140 characters.",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 140
},
"PstlAdr": {
"type": "object",
"description": "Address for the Branch",
"properties": {
"AdrTp": {
"type": "string",
"description": "Specifies the type of address based on the [ISO20022 AddressType1Code](https://www.iso20022.org/standardsrepository/type/AddressType1Code) list",
"minItems": 1,
"maxItems": 1,
"enum": [
"ADDR",
"PBOX",
"HOME",
"BIZZ",
"MLTO",
"DLVY"
],
"x-enumDescriptions": {
"ADDR": "Postal",
"PBOX": "PO Box",
"HOME": "Residential",
"BIZZ": "Business",
"MLTO": "Mail To",
"DLVY": "Delivery To"
}
},
"AdrLine": {
"description": "Information that locates and identifies the address for the party.",
"type": "array",
"maxLength": 70
},
"Dept": {
"description": "Information that locates and identifies the department for the party.",
"type": "string",
"maxLength": 70
},
"SubDept": {
"description": "Information that locates and identifies the sub department for the party.",
"type": "string",
"maxLength": 70
},
"StrtNm": {
"description": "Information that locates and identifies the street name for the party, as defined by postal services.",
"type": "string",
"maxLength": 70
},
"BldgNb": {
"description": "Information that locates and identifies the building number for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"PstCd": {
"description": "Information that locates and identifies postal code for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"TwnNm": {
"description": "Information that locates and identifies the city / town for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"CtrySubDvsn": {
"description": "Information that locates and identifies the state / county for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"Ctry": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country for the party, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list."
}
}
}
}
}
}
},
"Cdtr": {
"type": "object",
"title": "Creditor Information",
"description": "Party to which an amount of money is due.",
"properties": {
"Nm": {
"type": "string",
"description": "Allows the name of the Creditor to be held as a single value.</br><ul><li>Required if the creditor is an organization.</li><li>Not applicable if the creditor is an individual, specify `StrdNm` instead.</li></ul><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>Allowable characters: Alphanumeric and space.<li>Names with multiple words must be separated by a space.<li>For example, specify \"Widgets Org\", as `Widgets Org`.<li>Provide a truncated name if longer than 140 characters.",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 140
},
"StrdNm": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Allows the name of the Creditor to be held in a structured format.</br><ul><li>Required if the creditor is an individual.</li><li>Not applicable if the creditor is an organization, use `Nm` instead of `StrdNm`.</li></ul>",
"required": [
"FirstNm",
"LastNm"
],
"properties": {
"FirstNm": {
"description": "First name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the first name has two or more words, separate them with a space.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.<li>Provide a truncated name if longer than allowable characters.</ul><b>Example</b></br><ul><li>If the party's full name is 'Norma-Jean Baker' where 'Norma-Jean' is the first name, the `StrdNm.FirstNm` value must be 'Norma Jean'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"MidNm": {
"description": "Middle name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm": {
"description": "Last name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the last name has two or more words, separate them with a space.<li>Provide a truncated name if longer than allowable characters.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.</ul><b>Example</b></br><ul><li>If the party's full name is 'Enrique Miguel Iglesias Preysler,' where 'Iglesias Preysler' is the last name, the `StrdNm.LastNm` value must be 'Iglesias Preysler'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm2": {
"description": "Secondary last name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"NtrlNm": {
"description": "Name in local character set or language.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Title": {
"description": "Title by which the party is known and which is usually used to identify the party.",
"type": "string",
"minLength": 1,
"maxLength": 20
}
}
},
"CtryOfRes": {
"type": "string",
"description": "Allows the Country of Residence of the Creditor to be held. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list.",
"pattern": "^[A-Z]{2}$"
},
"PstlAdr": {
"type": "object",
"description": "Allows the address of the Creditor to be held.",
"properties": {
"AdrTp": {
"type": "string",
"description": "Specifies the type of address based on the [ISO20022 AddressType1Code](https://www.iso20022.org/standardsrepository/type/AddressType1Code) list",
"minItems": 1,
"maxItems": 1,
"enum": [
"ADDR",
"PBOX",
"HOME",
"BIZZ",
"MLTO",
"DLVY"
],
"x-enumDescriptions": {
"ADDR": "Postal",
"PBOX": "PO Box",
"HOME": "Residential",
"BIZZ": "Business",
"MLTO": "Mail To",
"DLVY": "Delivery To"
}
},
"AdrLine": {
"description": "Information that locates and identifies the address for the party.",
"type": "array",
"maxLength": 70
},
"Dept": {
"description": "Information that locates and identifies the department for the party.",
"type": "string",
"maxLength": 70
},
"SubDept": {
"description": "Information that locates and identifies the sub department for the party.",
"type": "string",
"maxLength": 70
},
"StrtNm": {
"description": "Information that locates and identifies the street name for the party, as defined by postal services.",
"type": "string",
"maxLength": 70
},
"BldgNb": {
"description": "Information that locates and identifies the building number for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"PstCd": {
"description": "Information that locates and identifies postal code for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"TwnNm": {
"description": "Information that locates and identifies the city / town for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"CtrySubDvsn": {
"description": "Information that locates and identifies the state / county for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"Ctry": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country for the party, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list."
}
}
},
"CtctDtls": {
"type": "object",
"description": "Allows the contact of the Creditor to be held.",
"properties": {
"NmPrfx": {
"type": "string",
"description": "List based on ISO 20022 NamePrefix1Code List",
"enum": [
"DOCT",
"MIST",
"MISS",
"MADM"
],
"x-enumDescriptions": {
"DOCT": "Doctor",
"MIST": "Mister",
"MISS": "Miss",
"MADM": "Madam"
}
},
"Nm": {
"type": "string",
"description": "Name by which a party is known and which is usually used to identify that party.",
"maxLength": 140
},
"PhneNb": {
"type": "string",
"description": "Phone Number",
"maxLength": 15,
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"MobNb": {
"type": "string",
"description": "Mobile Phone Number",
"maxLength": 15,
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"FaxNb": {
"type": "string",
"description": "Fax Number",
"maxLength": 15,
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"EmailAdr": {
"type": "string",
"description": "Address for electronic mail (e-mail).",
"format": "email",
"maxLength": 2048
},
"Othr": {
"type": "string",
"description": "Contact details in another form.",
"maxLength": 35
}
}
},
"Id": {
"type": "object",
"description": "Unique and unambiguous way to identify the Creditor.",
"properties": {
"OrgId": {
"type": "object",
"description": "Unique and unambiguous way to identify an individual or organization.",
"properties": {
"AnyBIC": {
"type": "string",
"pattern": "^([a-zA-Z0-9_-]){8,11}$",
"description": "The Business identifier code (BIC) allocated to a receiving institution by the [ISO 9362 Registration Authority](https://www.iso.org/standard/84108.html)."
},
"DtAndPlcofIncorprtn": {
"type": "object",
"description": "<b>[Soft field](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the organization's date and place of incorporation.",
"properties": {
"DtofIncorprtn": {
"type": "string",
"description": "The date of incorporation for the organization.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"CtryofIncorprtn": {
"type": "string",
"description": "Information that locates and identifies the country, as defined by postal services where the organization was incorporated. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.",
"pattern": "^[A-Z]{2}"
}
}
},
"Othr": {
"type": "array",
"description": "An array of objects, each containing unique identification of an organization, as assigned by an institution, using an identification scheme.",
"items": {
"type": "object",
"properties": {
"Id": {
"description": "Identification assigned by an institution.",
"type": "string",
"maxLength": 35
},
"Issr": {
"description": "Entity that assigns the identification.",
"type": "string",
"maxLength": 35
},
"DtOfIsse": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Issue date of the supporting documentation.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"DtOfXpry": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Expiration date of the supporting documentation.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"SchmeNm": {
"type": "object",
"description": "Name of the organization identification scheme.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ExternalorganizationIdentification1Code List",
"enum": [
"BANK",
"CBID",
"CHID",
"CINC",
"COID",
"CUST",
"DUNS",
"EMPL",
"GS1G",
"SREN",
"SRET",
"TXID",
"USCC"
],
"x-enumDescriptions": {
"BANK": "Bank Party Identification",
"CBID": "Central Bank Identification Number",
"CHID": "Clearing Identification Number",
"CINC": "Certificate Of Incorporation Number",
"COID": "Country Identification Code",
"CUST": "Customer Number",
"DUNS": "Data Universal Numbering System",
"EMPL": "Employer Identification Number",
"GS1G": "GS1GLN Identifier",
"SREN": "SIREN",
"SRET": "SIRET",
"TXID": "Tax Identification Number",
"USCC": "Unified Social Credit Code"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
}
}
}
},
"RelShipToDbtr": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the relationship between the Sender and Receiver.",
"enum": [
"BRAN",
"CUST",
"FRAN",
"HOLD",
"PART",
"SUBS",
"SUPP"
],
"x-enumDescriptions": {
"BRAN": "Branch or representative office",
"CUST": "Customer",
"FRAN": "Franchisee or franchisor",
"HOLD": "Holding company",
"PART": "Business partner",
"SUBS": "Subsidiary company",
"SUPP": "Supplier"
}
},
"Rprtv": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the name of the organization's representative.",
"properties": {
"StrdNm": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Allows the name of the organization's representative to be held in a structured format.",
"required": [
"FirstNm",
"LastNm"
],
"properties": {
"FirstNm": {
"description": "First name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the first name has two or more words, separate them with a space.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.<li>Provide a truncated name if longer than allowable characters.</ul><b>Example</b></br><ul><li>If the party's full name is 'Norma-Jean Baker' where 'Norma-Jean' is the first name, the `StrdNm.FirstNm` value must be 'Norma Jean'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"MidNm": {
"description": "Middle name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm": {
"description": "Last name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the last name has two or more words, separate them with a space.<li>Provide a truncated name if longer than allowable characters.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.</ul><b>Example</b></br><ul><li>If the party's full name is 'Enrique Miguel Iglesias Preysler,' where 'Iglesias Preysler' is the last name, the `StrdNm.LastNm` value must be 'Iglesias Preysler'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm2": {
"description": "Secondary last name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"NtrlNm": {
"description": "Name in local character set or language.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Title": {
"description": "Title by which the party is known and which is usually used to identify the party.",
"type": "string",
"minLength": 1,
"maxLength": 20
}
}
}
}
}
}
},
"PrvtId": {
"type": "object",
"description": "Unique and unambiguous identification of a person, e.g., passport.",
"properties": {
"DtAndPlcOfBirth": {
"type": "object",
"description": "Date and place of birth of a person.",
"properties": {
"BirthDt": {
"description": "Information that identifies the date of Birth for the party.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"PrvcOfBirth": {
"description": "Information that locates and identifies the Province of birth for the party.",
"type": "string",
"maxLength": 35
},
"CityOfBirth": {
"description": "Information that locates and identifies the city of birth for the party.",
"type": "string",
"maxLength": 35
},
"CtryOfBirth": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country of birth for the party, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list."
}
}
},
"Othr": {
"type": "array",
"description": "An array of objects, each containing the unique identification of a party, as assigned by an institution, using an identification scheme.",
"items": {
"type": "object",
"properties": {
"Id": {
"description": "Value to be used to identify the party",
"type": "string",
"maxLength": 35
},
"Issr": {
"description": "Information for the Entity that assigns the identification.",
"type": "string",
"maxLength": 35
},
"SchmeNm": {
"type": "object",
"description": "Name of the identification scheme used to identify an individual.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ISO20022 ExternalPersonIdentification1Code List ",
"enum": [
"ARNU",
"CCPT",
"CUST",
"DRLC",
"EMPL",
"NIDN",
"SOS",
"TELE",
"TXID"
],
"x-enumDescriptions": {
"ARNU": "Alien Registration Number",
"CCPT": "Passport Number",
"CUST": "Customer Identification Number",
"DRLC": "Drivers License Number",
"EMPL": "Employee Identification Number",
"NIDN": "National Identity Number",
"SOS": "Social Security Number",
"TELE": "Telephone Number",
"TXID": "Tax Identification Number"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"DtOfIss": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Issue date of the supporting documentation.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"DtOfXpry": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Expiration date of the supporting documentation.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"MrzNb": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Machine Readable Zone for Passport. This field only applies if the ID is a passport.",
"type": "string",
"maxLength": 88,
"pattern": "^[A-Z<]{1}[A-Z0-9<]{1}[A-Z<]{3}[0-9<]{6}[A0-9<]{1}[0-9<]{1}[A0-9<]{7}[A-Z<]{1}[0-9<]{1}[0-9<]{3}[A0-9<]{1}[0-9<]{1}[A0-9<]{7}[0-9<]{14}$"
}
}
}
},
"Gndr": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Information that captures the Gender of a party.",
"type": "string",
"maxLength": 6,
"enum": [
"Male",
"Female",
"Other"
],
"x-enumDescriptions": {
"Male": "Male",
"Female": "Female",
"Other": "Other"
}
},
"Prfssn": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Information that captures the occupation of a party.",
"type": "string",
"maxLength": 35
},
"RelShipToDbtr": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Relationship of the receiving party to the sending party.<br/><strong>Note</strong>: This information is required within the creditor object `cdtr` for payout in the Philippines.",
"type": "string",
"enum": [
"CHIL",
"CUST",
"EMPL",
"EXSP",
"FREN",
"OTHR",
"PARE",
"PART",
"RELA",
"SELF",
"SIBL",
"SPOU",
"VEND"
],
"x-enumDescriptions": {
"CHIL": "Child",
"CUST": "Customer",
"EMPL": "Employee",
"EXSP": "Ex-spouse",
"FREN": "Friend",
"OTHR": "Other",
"PARE": "Parent",
"PART": "Business partner",
"RELA": "Relation",
"SELF": "Self",
"SIBL": "Sibling",
"SPOU": "Covering Spouse/Partner",
"VEND": "Vendor"
}
},
"Ntlty": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "ISO Country Code of nationality of the party.<br/><br/>Deprecated in favor of `UltmtCdtr.PrvtId.Ctznsh.Ntlty`",
"maxLength": 3,
"deprecated": {
"description": "Deprecated in favor of `UltmtCdtr.PrvtId.Ctznsh.Ntlty`",
"deprecatedVersion": "1.1"
}
},
"Residence": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "ISO Country Code of residence of the party.<br/><br/>Deprecated: Must be served by `UltmtCdtr.CtryOfRes`",
"maxLength": 3,
"deprecated": {
"description": "Must be served by `UltmtCdtr.CtryOfRes`.",
"deprecatedVersion": "As per latest ISO 20022 PACS.008 standard."
}
},
"Ctznsh": {
"type": "object",
"properties": {
"Ntlty": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Alpha-2 country code for the nationality of the party in [ISO 3166-1](https://www.iso.org/obp/ui/#search) format.",
"maxLength": 3
},
"MnrId": {
"description": "Indicates whether the party is a minor.",
"type": "string",
"enum": [
"YES",
"NO"
],
"x-enumDescriptions": {
"YES": "Party is a minor.",
"NO": "Party is not a minor."
}
},
"StartDt": {
"description": "Start date of citizenship for the party.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"EndDt": {
"description": "End date of citizenship for the party.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
}
}
}
}
}
}
}
}
},
"CdtrAcct": {
"type": "object",
"title": "Creditor Account Information",
"description": "Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.",
"required": [
"Id"
],
"properties": {
"Nm": {
"type": "string",
"description": "Name by which the account is known and which is usually used to identify the Creditor account.",
"maxLength": 140
},
"Ccy": {
"type": "string",
"description": "Currency for the Creditor Account",
"pattern": "^[A-Z]{3,3}$"
},
"Id": {
"type": "object",
"description": "Identifier for the Creditor account.",
"properties": {
"IBAN": {
"type": "string",
"pattern": "^([a-zA-Z0-9_-]){15,35}$",
"description": "Holds the Creditor account number in International Bank Account Number (IBAN) format.<br/><br/><b>Usage Guidelines</b>:<br/><li>If you specify `IBAN`, do not specify `Othr.Id`.<li>This field is used in conjunction with `CdtrAgt.FinInstnId.BICFI`.<li>Example IBAN: `GB29NWBK60161331926819`."
},
"Othr": {
"type": "object",
"properties": {
"Id": {
"description": "Holds the Creditor account number in non-IBAN format.<br/><br/><b>Usage Guidelines</b><ul><li>If you specify `Othr.Id`, do not specify `IBAN`.<li>Provide information to support the following types of transfers or payouts:<ul><li><b>Bank account transfers</b>: Specify non-IBAN bank account number.<li><b>Card transfers</b>: Specify the card number.<li><b>Mobile wallet or e-wallet transfers</b>: Specify the mobile or e-wallet number.<li><b>Cash transfers or other transfers that do not require a payout instrument ID</b>: Specify `NOTREQUIRED`.<li><b>Bill payments</b>: Specify the bill reference number, or the account number, or the customer reference number.</ul><li>Use this property in conjunction with `CdtrAgt.ClrSysMmbId.MmbId`.</ul><b>Example non-IBAN string</b>: `5320130`",
"type": "string",
"maxLength": 34
},
"SchmeNm": {
"type": "object",
"description": "Name of the account identification scheme.",
"properties": {
"Cd": {
"type": "string",
"description": "Identifier of an account, as assigned by the account servicer, list based on a combination of ExternalAccountIdentification1Code and AccountIdentification30Choice ISO 20022 Lists. For more information, see [ExternalCodeSets2Q2020August2020](https://www.iso20022.org/sites/default/files/2020-08/ExternalCodeSets_2Q2020_August2020_v1.xlsx).<br/><br/><b>Usage Guidelines</b>:<br/><li>Do not specify `Othr.SchmeNm.Cd` if you do not specify `Othr.Id`.</li><br/><b>Examples values</b><br/><li>Bank account transfer: `BBAN`<li>Cash payout</b>: `CASH`",
"minItems": 1,
"maxItems": 1,
"enum": [
"AIIN",
"BBAN",
"CARD",
"CASH",
"CASHD2D",
"CUID",
"UPIC",
"EMail",
"MSISDN",
"Dmst",
"Other"
],
"x-enumDescriptions": {
"AIIN": "Issuer Identification Number",
"BBAN": "Basic Bank Account Number",
"CARD": "PAN of the Card identifying the account",
"CASH": "Cash Payments",
"CASHD2D": "Cash door-to-door delivery",
"CUID": "CHIPS Universal Identifier",
"UPIC": "Universal Payment Indentification Code",
"EMail": "Email Address",
"MSISDN": "Mobile Subscriber Integrated Service Digital Network, (i.e. mobile phone number of the SIM card).",
"Dmst": "Domestic",
"Other": "Other Identifier"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"Issr": {
"type": "string",
"description": "Entity that assigns the identification.",
"maxLength": 35
}
},
"required": [
"Id"
]
}
}
},
"Tp": {
"type": "object",
"description": "Nature or use of the Creditor account.",
"properties": {
"Cd": {
"type": "string",
"description": "Type of external cash account. The list is based on ISO20022 ExternalCashAccountType1Code List [27-Aug-2021](https://www.iso20022.org/sites/default/files/2021-08/ExternalCodeSets_2Q2021.xlsx). ",
"minItems": 1,
"maxItems": 1,
"enum": [
"CACC",
"CARD",
"CASH",
"CHAR",
"CISH",
"COMM",
"CPAC",
"LLSV",
"LOAN",
"MGLD",
"MOMA",
"NREX",
"ODFT",
"ONDP",
"OTHR",
"SACC",
"SLRY",
"SVGS",
"TAXE",
"TRAN",
"TRAS"
],
"x-enumDescriptions": {
"CACC": "Account used to post debits and credits when no specific account has been nominated.",
"CARD": "Card Account.",
"CASH": "Account used for the payment of cash.",
"CHAR": "Account used for charges if different from the account for payment.",
"CISH": "Account used for payment of income if different from the current cash account.",
"COMM": "Account used for commission if different from the account for payment.",
"CPAC": "Account used to post settlement debit and credit entries on behalf of a designated Clearing Participant.",
"LLSV": "Account used for savings with special interest and withdrawal terms.",
"LOAN": "Account used for loans.",
"MGLD": "Account used for a marginal lending facility.",
"MOMA": "Account used for money markets if different from the cash account.",
"NREX": "Account used for non-resident external.",
"ODFT": "Account is used for overdrafts.",
"ONDP": "Account used for overnight deposits.",
"OTHR": "Account not otherwise specified.",
"SACC": "Account used to post debit and credit entires, as a result of transactions cleared and settled through a specific clearing and settlement system.",
"SLRY": "Account used for salary payments.",
"SVGS": "Account used for savings.",
"TAXE": "Account used for taxes if different from the account for payment.",
"TRAN": "A transacting account is the most basic type of bank account that you can get. The main difference between transaction and check accounts is that you usually do not get a check book with your transacting account and neither are you offered an overdraft facility.",
"TRAS": "Account used for trading if different from the current cash account."
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
}
}
},
"UltmtCdtr": {
"type": "object",
"title": "Ultimate Creditor Information",
"description": "Ultimate party to which an amount of money is due.",
"properties": {
"Nm": {
"type": "string",
"description": "Allows the name of the Ultimate Creditor to be held as a single value.<br/><ul><li>Must include one (1) name string.<li>Allowable characters: Alphanumeric and space.<li>Names with multiple words must be separated by a space.<li>For example, specify \"Widgets Org\", as `Widgets Org`.<li>Provide a truncated name if longer than 140 characters.",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 140
},
"StrdNm": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Allows the name of the Ultimate Creditor to be held in a structured format.",
"required": [
"FirstNm",
"LastNm"
],
"properties": {
"FirstNm": {
"description": "First name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the first name has two or more words, separate them with a space.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.<li>Provide a truncated name if longer than allowable characters.</ul><b>Example</b></br><ul><li>If the party's full name is 'Norma-Jean Baker' where 'Norma-Jean' is the first name, the `StrdNm.FirstNm` value must be 'Norma Jean'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"MidNm": {
"description": "Middle name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm": {
"description": "Last name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the last name has two or more words, separate them with a space.<li>Provide a truncated name if longer than allowable characters.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.</ul><b>Example</b></br><ul><li>If the party's full name is 'Enrique Miguel Iglesias Preysler,' where 'Iglesias Preysler' is the last name, the `StrdNm.LastNm` value must be 'Iglesias Preysler'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm2": {
"description": "Secondary last name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"NtrlNm": {
"description": "Name in local character set or language.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Title": {
"description": "Title by which the party is known and which is usually used to identify the party.",
"type": "string",
"minLength": 1,
"maxLength": 20
}
}
},
"CtryOfRes": {
"type": "string",
"description": "Allows the Country of Residence of the Utlimate Creditor to be held. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list.",
"pattern": "^[A-Z]{2}$"
},
"PstlAdr": {
"type": "object",
"description": "Allows the address of the Ultimate Creditor to be held.",
"properties": {
"AdrTp": {
"type": "string",
"description": "Specifies the type of address based on the [ISO20022 AddressType1Code](https://www.iso20022.org/standardsrepository/type/AddressType1Code) list",
"minItems": 1,
"maxItems": 1,
"enum": [
"ADDR",
"PBOX",
"HOME",
"BIZZ",
"MLTO",
"DLVY"
],
"x-enumDescriptions": {
"ADDR": "Postal",
"PBOX": "PO Box",
"HOME": "Residential",
"BIZZ": "Business",
"MLTO": "Mail To",
"DLVY": "Delivery To"
}
},
"AdrLine": {
"description": "Information that locates and identifies the address for the party.",
"type": "array",
"maxLength": 70
},
"Dept": {
"description": "Information that locates and identifies the department for the party.",
"type": "string",
"maxLength": 70
},
"SubDept": {
"description": "Information that locates and identifies the sub department for the party.",
"type": "string",
"maxLength": 70
},
"StrtNm": {
"description": "Information that locates and identifies the street name for the party, as defined by postal services.",
"type": "string",
"maxLength": 70
},
"BldgNb": {
"description": "Information that locates and identifies the building number for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"PstCd": {
"description": "Information that locates and identifies postal code for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"TwnNm": {
"description": "Information that locates and identifies the city / town for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"CtrySubDvsn": {
"description": "Information that locates and identifies the state / county for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"Ctry": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country for the party, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list."
}
}
},
"CtctDtls": {
"type": "object",
"description": "Allows the contact of the Ultimate Creditor to be held.",
"properties": {
"NmPrfx": {
"type": "string",
"description": "List based on ISO 20022 NamePrefix1Code List",
"enum": [
"DOCT",
"MIST",
"MISS",
"MADM"
],
"x-enumDescriptions": {
"DOCT": "Doctor",
"MIST": "Mister",
"MISS": "Miss",
"MADM": "Madam"
}
},
"Nm": {
"type": "string",
"description": "Name by which a party is known and which is usually used to identify that party.",
"maxLength": 140
},
"PhneNb": {
"type": "string",
"description": "Phone Number",
"maxLength": 15,
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"MobNb": {
"type": "string",
"description": "Mobile Phone Number",
"maxLength": 15,
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"FaxNb": {
"type": "string",
"description": "Fax Number",
"maxLength": 15,
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"EmailAdr": {
"type": "string",
"description": "Address for electronic mail (e-mail).",
"format": "email",
"maxLength": 2048
},
"Othr": {
"type": "string",
"description": "Contact details in another form.",
"maxLength": 35
}
}
},
"Id": {
"type": "object",
"description": "Unique and unambiguous way to identify the Ultimate Creditor.",
"properties": {
"OrgId": {
"type": "object",
"description": "Unique and unambiguous way to identify an individual or organization.",
"properties": {
"AnyBIC": {
"type": "string",
"pattern": "^([a-zA-Z0-9_-]){8,11}$",
"description": "The Business identifier code (BIC) allocated to a receiving institution by the [ISO 9362 Registration Authority](https://www.iso.org/standard/84108.html)."
},
"DtAndPlcofIncorprtn": {
"type": "object",
"description": "<b>[Soft field](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the organization's date and place of incorporation.",
"properties": {
"DtofIncorprtn": {
"type": "string",
"description": "The date of incorporation for the organization.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"CtryofIncorprtn": {
"type": "string",
"description": "Information that locates and identifies the country, as defined by postal services where the organization was incorporated. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.",
"pattern": "^[A-Z]{2}"
}
}
},
"Othr": {
"type": "array",
"description": "An array of objects, each containing unique identification of an organization, as assigned by an institution, using an identification scheme.",
"items": {
"type": "object",
"properties": {
"Id": {
"description": "Identification assigned by an institution.",
"type": "string",
"maxLength": 35
},
"Issr": {
"description": "Entity that assigns the identification.",
"type": "string",
"maxLength": 35
},
"DtOfIsse": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Issue date of the supporting documentation.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"DtOfXpry": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Expiration date of the supporting documentation.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"SchmeNm": {
"type": "object",
"description": "Name of the organization identification scheme.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ExternalorganizationIdentification1Code List",
"enum": [
"BANK",
"CBID",
"CHID",
"CINC",
"COID",
"CUST",
"DUNS",
"EMPL",
"GS1G",
"SREN",
"SRET",
"TXID",
"USCC"
],
"x-enumDescriptions": {
"BANK": "Bank Party Identification",
"CBID": "Central Bank Identification Number",
"CHID": "Clearing Identification Number",
"CINC": "Certificate Of Incorporation Number",
"COID": "Country Identification Code",
"CUST": "Customer Number",
"DUNS": "Data Universal Numbering System",
"EMPL": "Employer Identification Number",
"GS1G": "GS1GLN Identifier",
"SREN": "SIREN",
"SRET": "SIRET",
"TXID": "Tax Identification Number",
"USCC": "Unified Social Credit Code"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
}
}
}
},
"RelShipToDbtr": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the relationship between the Sender and Receiver.",
"enum": [
"BRAN",
"CUST",
"FRAN",
"HOLD",
"PART",
"SUBS",
"SUPP"
],
"x-enumDescriptions": {
"BRAN": "Branch or representative office",
"CUST": "Customer",
"FRAN": "Franchisee or franchisor",
"HOLD": "Holding company",
"PART": "Business partner",
"SUBS": "Subsidiary company",
"SUPP": "Supplier"
}
},
"Rprtv": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the name of the organization's representative.",
"properties": {
"StrdNm": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Allows the name of the organization's representative to be held in a structured format.",
"required": [
"FirstNm",
"LastNm"
],
"properties": {
"FirstNm": {
"description": "First name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the first name has two or more words, separate them with a space.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.<li>Provide a truncated name if longer than allowable characters.</ul><b>Example</b></br><ul><li>If the party's full name is 'Norma-Jean Baker' where 'Norma-Jean' is the first name, the `StrdNm.FirstNm` value must be 'Norma Jean'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"MidNm": {
"description": "Middle name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm": {
"description": "Last name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the last name has two or more words, separate them with a space.<li>Provide a truncated name if longer than allowable characters.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.</ul><b>Example</b></br><ul><li>If the party's full name is 'Enrique Miguel Iglesias Preysler,' where 'Iglesias Preysler' is the last name, the `StrdNm.LastNm` value must be 'Iglesias Preysler'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm2": {
"description": "Secondary last name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"NtrlNm": {
"description": "Name in local character set or language.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Title": {
"description": "Title by which the party is known and which is usually used to identify the party.",
"type": "string",
"minLength": 1,
"maxLength": 20
}
}
}
}
}
}
},
"PrvtId": {
"type": "object",
"description": "Unique and unambiguous identification of a person, e.g., passport.",
"properties": {
"DtAndPlcOfBirth": {
"type": "object",
"description": "Date and place of birth of a person.",
"properties": {
"BirthDt": {
"description": "Information that identifies the date of Birth for the party.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"PrvcOfBirth": {
"description": "Information that locates and identifies the Province of birth for the party.",
"type": "string",
"maxLength": 35
},
"CityOfBirth": {
"description": "Information that locates and identifies the city of birth for the party.",
"type": "string",
"maxLength": 35
},
"CtryOfBirth": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country of birth for the party, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list."
}
}
},
"Othr": {
"type": "array",
"description": "An array of objects, each containing the unique identification of a party, as assigned by an institution, using an identification scheme.",
"items": {
"type": "object",
"properties": {
"Id": {
"description": "Value to be used to identify the party",
"type": "string",
"maxLength": 35
},
"Issr": {
"description": "Information for the Entity that assigns the identification.",
"type": "string",
"maxLength": 35
},
"SchmeNm": {
"type": "object",
"description": "Name of the identification scheme used to identify an individual.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ISO20022 ExternalPersonIdentification1Code List ",
"enum": [
"ARNU",
"CCPT",
"CUST",
"DRLC",
"EMPL",
"NIDN",
"SOS",
"TELE",
"TXID"
],
"x-enumDescriptions": {
"ARNU": "Alien Registration Number",
"CCPT": "Passport Number",
"CUST": "Customer Identification Number",
"DRLC": "Drivers License Number",
"EMPL": "Employee Identification Number",
"NIDN": "National Identity Number",
"SOS": "Social Security Number",
"TELE": "Telephone Number",
"TXID": "Tax Identification Number"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"DtOfIss": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Issue date of the supporting documentation.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"DtOfXpry": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Expiration date of the supporting documentation.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"MrzNb": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Machine Readable Zone for Passport. This field only applies if the ID is a passport.",
"type": "string",
"maxLength": 88,
"pattern": "^[A-Z<]{1}[A-Z0-9<]{1}[A-Z<]{3}[0-9<]{6}[A0-9<]{1}[0-9<]{1}[A0-9<]{7}[A-Z<]{1}[0-9<]{1}[0-9<]{3}[A0-9<]{1}[0-9<]{1}[A0-9<]{7}[0-9<]{14}$"
}
}
}
},
"Gndr": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Information that captures the Gender of a party.",
"type": "string",
"maxLength": 6,
"enum": [
"Male",
"Female",
"Other"
],
"x-enumDescriptions": {
"Male": "Male",
"Female": "Female",
"Other": "Other"
}
},
"Prfssn": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Information that captures the occupation of a party.",
"type": "string",
"maxLength": 35
},
"RelShipToDbtr": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Relationship of the receiving party to the sending party.<br/><strong>Note</strong>: This information is required within the creditor object `cdtr` for payout in the Philippines.",
"type": "string",
"enum": [
"CHIL",
"CUST",
"EMPL",
"EXSP",
"FREN",
"OTHR",
"PARE",
"PART",
"RELA",
"SELF",
"SIBL",
"SPOU",
"VEND"
],
"x-enumDescriptions": {
"CHIL": "Child",
"CUST": "Customer",
"EMPL": "Employee",
"EXSP": "Ex-spouse",
"FREN": "Friend",
"OTHR": "Other",
"PARE": "Parent",
"PART": "Business partner",
"RELA": "Relation",
"SELF": "Self",
"SIBL": "Sibling",
"SPOU": "Covering Spouse/Partner",
"VEND": "Vendor"
}
},
"Ntlty": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "ISO Country Code of nationality of the party.<br/><br/>Deprecated in favor of `UltmtCdtr.PrvtId.Ctznsh.Ntlty`",
"maxLength": 3,
"deprecated": {
"description": "Deprecated in favor of `UltmtCdtr.PrvtId.Ctznsh.Ntlty`",
"deprecatedVersion": "1.1"
}
},
"Residence": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "ISO Country Code of residence of the party.<br/><br/>Deprecated: Must be served by `UltmtCdtr.CtryOfRes`",
"maxLength": 3,
"deprecated": {
"description": "Must be served by `UltmtCdtr.CtryOfRes`.",
"deprecatedVersion": "As per latest ISO 20022 PACS.008 standard."
}
},
"Ctznsh": {
"type": "object",
"properties": {
"Ntlty": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Alpha-2 country code for the nationality of the party in [ISO 3166-1](https://www.iso.org/obp/ui/#search) format.",
"maxLength": 3
},
"MnrId": {
"description": "Indicates whether the party is a minor.",
"type": "string",
"enum": [
"YES",
"NO"
],
"x-enumDescriptions": {
"YES": "Party is a minor.",
"NO": "Party is not a minor."
}
},
"StartDt": {
"description": "Start date of citizenship for the party.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"EndDt": {
"description": "End date of citizenship for the party.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
}
}
}
}
}
}
}
}
},
"InstForCdtrAgt": {
"type": "object",
"title": "Instruction for Creditor Agent",
"description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ISO20022 Instruction3Code List",
"minItems": 1,
"maxItems": 1,
"enum": [
"CHQB",
"HOLD",
"PHOB",
"TELB"
],
"x-enumDescriptions": {
"CHQB": "Pay Creditor By Cheque",
"HOLD": "Hold Cash For Creditor",
"PHOB": "Phone Beneficiary",
"TELB": "Telecom"
}
},
"InstrInf": {
"type": "string",
"description": "Further information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.",
"maxLength": 140
}
}
},
"Purp": {
"type": "object",
"title": "Payment Purpose",
"description": "Underlying reason for the payment transaction.",
"properties": {
"Cd": {
"type": "string",
"description": "Underlying reason for the payment transaction, as published in an external purpose code list. Based on ISO20022 ExternalPurpose1Code List",
"enum": [
"ACCT",
"ADCS",
"ADMG",
"ADVA",
"AEMP",
"AGRT",
"AIRB",
"ALLW",
"ALMY",
"ANNI",
"ANTS",
"AREN",
"B112",
"BBSC",
"BCDM",
"BCFG",
"BECH",
"BENE",
"BEXP",
"BFWD",
"BKDF",
"BKFE",
"BKFM",
"BKIP",
"BKPP",
"BLDM",
"BNET",
"BOCE",
"BONU",
"BR12",
"BUSB",
"CAFI",
"CASH",
"CBFF",
"CBFR",
"CBLK",
"CBTV",
"CCHD",
"CCIR",
"CCPC",
"CCPM",
"CCRD",
"CCSM",
"CDBL",
"CDCB",
"CDCD",
"CDCS",
"CDDP",
"CDEP",
"CDOC",
"CDQC",
"CFDI",
"CFEE",
"CGDD",
"CHAR",
"CLPR",
"CMDT",
"COLL",
"COMC",
"COMM",
"COMP",
"COMT",
"CORT",
"COST",
"CPKC",
"CPYR",
"CRDS",
"CRPR",
"CRSP",
"CRTL",
"CSDB",
"CSLP",
"CVCF",
"DBTC",
"DCRD",
"DEPT",
"DERI",
"DIVD",
"DMEQ",
"DNTS",
"DSMT",
"DVPM",
"ECPG",
"ECPR",
"ECPU",
"EDUC",
"ELEC",
"ENRG",
"EPAY",
"EQPT",
"EQUS",
"ESTX",
"ETUP",
"EXPT",
"EXTD",
"FACT",
"FAMI",
"FAND",
"FCOL",
"FCPM",
"FEES",
"FERB",
"FIXI",
"FNET",
"FORW",
"FREX",
"FUTR",
"FWBC",
"FWCC",
"FWLV",
"FWSB",
"FWSC",
"FXNT",
"GASB",
"GDDP",
"GDDS",
"GDFR",
"GDSV",
"GELE",
"GFRP",
"GIFT",
"GOVI",
"GOVT",
"GSCB",
"GSTX",
"GTOY",
"GVEA",
"GVEB",
"GVEC",
"GVED",
"GWLT",
"HEDG",
"HLRP",
"HLST",
"HLTC",
"HLTI",
"HREC",
"HSPC",
"HSTX",
"ICCP",
"ICRF",
"IDCP",
"IHRP",
"INPC",
"INPR",
"INSC",
"INSM",
"INSU",
"INTC",
"INTE",
"INTP",
"INTX",
"INVS",
"IPAY",
"IPCA",
"IPDO",
"IPEA",
"IPEC",
"IPEW",
"IPPS",
"IPRT",
"IPU2",
"IPUW",
"IVPT",
"LBIN",
"LBRI",
"LCOL",
"LFEE",
"LICF",
"LIFI",
"LIMA",
"LMEQ",
"LMFI",
"LMRK",
"LOAN",
"LOAR",
"LREB",
"LREV",
"LSFL",
"LTCF",
"MAFC",
"MARF",
"MARG",
"MBSB",
"MBSC",
"MCDM",
"MCFG",
"MDCS",
"MGCC",
"MGSC",
"MISC",
"MP2B",
"MP2P",
"MSVC",
"MTUP",
"NETT",
"NITX",
"NOWS",
"NWCH",
"NWCM",
"OCCC",
"OCDM",
"OCFG",
"OFEE",
"OPBC",
"OPCC",
"OPSB",
"OPSC",
"OPTN",
"OTCD",
"OTHR",
"OTLC",
"PADD",
"PAYR",
"PEFC",
"PENO",
"PENS",
"PHON",
"POPE",
"PPTI",
"PRCP",
"PRME",
"PTSP",
"PTXP",
"RCKE",
"RCPT",
"RDTX",
"REBT",
"REFU",
"RELG",
"REMT",
"RENT",
"REOD",
"REPO",
"RHBS",
"RIMB",
"RINP",
"RLWY",
"ROYA",
"RPBC",
"RPCC",
"RPNT",
"RPSB",
"RPSC",
"RRBN",
"RRCT",
"RRTP",
"RVPM",
"RVPO",
"SALA",
"SAVG",
"SBSC",
"SCEX",
"SCHR",
"SCIE",
"SCIN",
"SCIR",
"SCRP",
"SCSD",
"SCTS",
"SCTX",
"SCVE",
"SCWD",
"SECU",
"SEPI",
"SERV",
"SHBC",
"SHCC",
"SHSL",
"SLEB",
"SLOA",
"SLPI",
"SPLT",
"SPSP",
"SRAG",
"SSBE",
"STDY",
"SUBS",
"SUPP",
"SWBC",
"SWCC",
"SWFP",
"SWPP",
"SWPT",
"SWRS",
"SWSB",
"SWSC",
"SWUF",
"TAXR",
"TAXS",
"TBAN",
"TBAS",
"TBBC",
"TBCC",
"TBIL",
"TCSC",
"TELI",
"TLRF",
"TLRR",
"TMPG",
"TPRI",
"TPRP",
"TRAD",
"TRCP",
"TREA",
"TRFD",
"TRNC",
"TRPT",
"TRVC",
"UBIL",
"UNIT",
"VATX",
"VIEW",
"WEBI",
"WHLD",
"WTER"
],
"x-enumDescriptions": {
"ACCT": "Account Management",
"ADCS": "Advisory Donation Copyright Services",
"ADMG": "Administrative Management",
"ADVA": "Advance Payment",
"AEMP": "Active Employment Policy",
"AGRT": "AgriculturalTransfer",
"AIRB": "Air",
"ALLW": "Allowance",
"ALMY": "Alimony Payment",
"ANNI": "Annuity",
"ANTS": "Anesthesia Services",
"AREN": "Accounts Receivables Entry",
"B112": "Trailer Fee Payment",
"BBSC": "Baby Bonus Scheme",
"BCDM": "Bearer Cheque Domestic",
"BCFG": "Bearer Cheque Foreign",
"BECH": "Child Benefit",
"BENE": "Unemployment Disability Benefit",
"BEXP": "Business Expenses",
"BFWD": "Bond Forward",
"BKDF": "Bank Loan Delayed Draw Funding",
"BKFE": "Bank Loan Fees",
"BKFM": "Bank Loan Funding Memo",
"BKIP": "Bank Loan Accrued Interest Payment",
"BKPP": "Bank Loan Principal Paydown",
"BLDM": "Building Maintenance",
"BNET": "Bond Forward Netting",
"BOCE": "Back Office Conversion Entry",
"BONU": "Bonus Payment",
"BR12": "Trailer Fee Rebate",
"BUSB": "Bus",
"CAFI": "Custodian Management fee In-house",
"CASH": "Cash Management Transfer",
"CBFF": "Capital Building",
"CBFR": "Capital Building Retirement",
"CBLK": "Card Bulk Clearing",
"CBTV": "Cable TV Bill",
"CCHD": "Cash compensation, Helplessness, Disability",
"CCIR": "Cross Currency IRS",
"CCPC": "CCP Cleared Initial Margin",
"CCPM": "CCP Cleared Variation Margin",
"CCRD": "Credit Card Payment",
"CCSM": "CCP Cleared Initial Margin Segregated Cash",
"CDBL": "Credit Card Bill",
"CDCB": "Card Payment with CashBack",
"CDCD": "Cash Disbursement Cash Settlement",
"CDCS": "Cash Disbursement with Surcharging",
"CDDP": "Card Deferred Payment",
"CDEP": "Credit default event payment",
"CDOC": "Original Credit",
"CDQC": "QuasiCash",
"CFDI": "Capital falling due In-house",
"CFEE": "Cancellation Fee",
"CGDD": "Card Generated Direct Debit",
"CHAR": "Charity Payment",
"CLPR": "Car Loan Principal Repayment",
"CMDT": "Commodity Transfer",
"COLL": "Collection Payment",
"COMC": "Commercial Payment",
"COMM": "Commission",
"COMP": "Compensation Payment",
"COMT": "Consumer Third Party Consolidated Payment",
"CORT": "Trade Settlement Payment",
"COST": "Costs",
"CPKC": "Carpark Charges",
"CPYR": "Copyright",
"CRDS": "Credit DefaultSwap",
"CRPR": "Cross Product",
"CRSP": "Credit Support",
"CRTL": "Credit Line",
"CSDB": "Cash Disbursement Cash Management",
"CSLP": "Company Social Loan Payment To Bank",
"CVCF": "Convalescent Care Facility",
"DBTC": "Debit Collection Payment",
"DCRD": "Debit Card Payment",
"DEPT": "Deposit",
"DERI": "Derivatives",
"DIVD": "Dividend",
"DMEQ": "Durable Medicale Equipment",
"DNTS": "Dental Services",
"DSMT": "Printed Order Disbursement",
"DVPM": "Deliver Against Payment",
"ECPG": "Guaranteed EPayment",
"ECPR": "EPayment Return",
"ECPU": "Non Guaranteed EPayment",
"EDUC": "Education",
"ELEC": "Electricity Bill",
"ENRG": "Energies",
"EPAY": "Epayment",
"EQPT": "Equity Option",
"EQUS": "Equity Swap",
"ESTX": "Estate Tax",
"ETUP": "E-Purse Top Up",
"EXPT": "Exotic Option",
"EXTD": "Exchange Traded Derivatives",
"FACT": "Factor Update related payment",
"FAMI": "Financial Aid In Case Of Natural Disaster",
"FAND": "Family Supported Related Payments",
"FCOL": "Fee Collection",
"FCPM": "Late Payment of Fees & Charges",
"FEES": "Payment of Fees",
"FERB": "Ferry",
"FIXI": "Fixed Income",
"FNET": "Futures Netting Payment",
"FORW": "Forward Foreign Exchange",
"FREX": "Foreign Exchange",
"FUTR": "Futures",
"FWBC": "Forward Broker Owned Cash Collateral",
"FWCC": "Forward Client Owned Cash Collateral",
"FWLV": "Foreign Worker Levy",
"FWSB": "Forward Broker Owned Cash Collateral Segregated",
"FWSC": "Forward Client Owned Segregated Cash Collateral",
"FXNT": "Foreign Exchange Related Netting",
"GASB": "Gas Bill",
"GDDP": "Purchase or sale of daily provisions",
"GDDS": "Purchase or sale Of Goods",
"GDFR": "Purchase or sale of goods fashion and retail cosmetics",
"GDSV": "Purchase Sale Of Goods And Services",
"GELE": "Purchase or sale of goods electronics",
"GFRP": "Guarantee Fund Rights Payment",
"GIFT": "Gift",
"GOVI": "Government Insurance",
"GOVT": "Government Payment",
"GSCB": "Purchase Sale Of Goods And Services With CashBack",
"GSTX": "Goods & Services Tax",
"GTOY": "Purchase or sale of goods toys",
"GVEA": "Austrian Government Employees Category A",
"GVEB": "Austrian Government Employees Category B",
"GVEC": "Austrian Government Employees Category C",
"GVED": "Austrian Government Employees Category D",
"GWLT": "Goverment War Legislation Transfer",
"HEDG": "Hedging",
"HLRP": "Housing Loan Repayment",
"HLST": "Home Loan Settlement",
"HLTC": "Home Health Care",
"HLTI": "Health Insurance",
"HREC": "Housing Related Contribution",
"HSPC": "Hospital Care",
"HSTX": "Housing Tax",
"ICCP": "Irrevocable Credit Card Payment",
"ICRF": "Intermediate Care Facility",
"IDCP": "Irrevocable Debit Card Payment",
"IHRP": "Instalment Hire Purchase Agreement",
"INPC": "Insurance Premium Car",
"INPR": "Insurance Premium Refund",
"INSC": "Payment of Insurance Claim",
"INSM": "Installment",
"INSU": "Insurance Premium",
"INTC": "Intra Company Payment",
"INTE": "Interest",
"INTP": "Intra Party Payment",
"INTX": "Income Tax",
"INVS": "Investment & Securities",
"IPAY": "Instant Payments",
"IPCA": "Instant Payments Cancellation",
"IPDO": "Instant Payments for donations",
"IPEA": "Instant Payments in E-Commerce without address data",
"IPEC": "Instant Payments in E-Commerce with address data",
"IPEW": "Instant Payments in E-Commerce",
"IPPS": "Instant Payments at POS",
"IPRT": "Instant Payments return",
"IPU2": "Instant Payments unattended vending machine with 2FA",
"IPUW": "Instant Payments unattended vending machine without 2FA",
"IVPT": "Invoice Payment",
"LBIN": "Lending Buy-In Netting",
"LBRI": "Labor Insurance",
"LCOL": "Lending Cash Collateral Free Movement",
"LFEE": "Lending Fees",
"LICF": "License Fee",
"LIFI": "Life Insurance",
"LIMA": "Liquidity Management",
"LMEQ": "Lending Equity marked-to-market cash collateral",
"LMFI": "Lending Fixed Income marked-to-market cash collateral",
"LMRK": "Lending unspecified type of marked-to-market cash collateral",
"LOAN": "Loan",
"LOAR": "Loan Repayment",
"LREB": "Lending rebate payments",
"LREV": "Lending Revenue Payments",
"LSFL": "Lending Claim Payment",
"LTCF": "Long Term Care Facility",
"MAFC": "Medical Aid Fund Contribution",
"MARF": "Medical Aid Refund",
"MARG": "Daily margin on listed derivatives",
"MBSB": "MBS Broker Owned Cash Collateral",
"MBSC": "MBS Client Owned Cash Collateral",
"MCDM": "Multi Curreny Cheque Domestic",
"MCFG": "Multi Curreny Cheque Foreign",
"MDCS": "Medical Services",
"MGCC": "Futures Initial Margin",
"MGSC": "Futures Initial Margin Client Owned Segregated Cash Collateral",
"MISC": "Miscellaneous",
"MP2B": "Mobile P2B Payment",
"MP2P": "Mobile P2P Payment",
"MSVC": "Multiple Service Types",
"MTUP": "Mobile Top Up",
"NETT": "Netting",
"NITX": "Net Income Tax",
"NOWS": "Not Otherwise Specified",
"NWCH": "Network Charge",
"NWCM": "Network Communication",
"OCCC": "Client owned OCC pledged collateral",
"OCDM": "Order Cheque Domestic",
"OCFG": "Order Cheque Foreign",
"OFEE": "Opening Fee",
"OPBC": "OTC Option Broker owned Cash collateral",
"OPCC": "OTC Option Client owned Cash collateral",
"OPSB": "OTC Option Broker Owned Segregated Cash Collateral",
"OPSC": "OTC Option Client Owned Cash Segregated Cash Collateral",
"OPTN": "FX Option",
"OTCD": "OTC Derivatives",
"OTHR": "Other",
"OTLC": "Other Telecom Related Bill",
"PADD": "Preauthorized debit",
"PAYR": "Payroll",
"PEFC": "Pension Fund Contribution",
"PENO": "Payment Based On Enforcement Order",
"PENS": "Pension Payment",
"PHON": "Telephone Bill",
"POPE": "Point of Purchase Entry",
"PPTI": "Property Insurance",
"PRCP": "Price Payment",
"PRME": "Precious Metal",
"PTSP": "Payment Terms",
"PTXP": "Property Tax",
"RCKE": "Re-presented Check Entry",
"RCPT": "Receipt Payment",
"RDTX": "Road Tax",
"REBT": "Rebate",
"REFU": "Refund",
"RELG": "Rental Lease General",
"REMT": "Remittance",
"RENT": "Rent",
"REOD": "Account Overdraft Repayment",
"REPO": "Repurchase Agreement",
"RHBS": "Rehabilitation Support",
"RIMB": "Reimbursement of a previous erroneous transaction",
"RINP": "Recurring Installment Payment",
"RLWY": "Railway",
"ROYA": "Royalties",
"RPBC": "Bi-lateral repo broker owned collateral",
"RPCC": "Repo client owned collateral",
"RPNT": "Bi-lateral repo internet netting",
"RPSB": "Bi-lateral repo broker owned segregated cash collateral",
"RPSC": "Bi-lateral Repo client owned segregated cash collateral",
"RRBN": "Round Robin",
"RRCT": "ReimbursementReceivedCreditTransfer",
"RRTP": "Related Request to Pay",
"RVPM": "Receive Against Payment",
"RVPO": "Reverse Repurchase Agreement",
"SALA": "Salary Payment",
"SAVG": "Savings",
"SBSC": "Securities Buy Sell Sell Buy Back<br/>Cash collateral related to a Securities Buy Sell Sell Buy Back.",
"SCEX": "Purchase or sale of services exhibition",
"SCHR": "Purchase or sale of services human resource",
"SCIE": "Single Currency IRS Exotic",
"SCIN": "Purchase or sale of services interpretation",
"SCIR": "Single Currency IRS",
"SCRP": "Securities Cross Products",
"SCSD": "Purchase or sale of services software development",
"SCTS": "Purchase or sale of services translation",
"SCTX": "Service tax",
"SCVE": "Purchase Sale Of Services",
"SCWD": "Purchase or sale of services web design or development",
"SECU": "Securities",
"SEPI": "Securities Purchase In-house",
"SERV": "Service Charges",
"SHBC": "Broker owned collateral Short Sale",
"SHCC": "Client owned collateral Short Sale",
"SHSL": "Short Sell",
"SLEB": "Securities Lending And Borrowing",
"SLOA": "SecuredLoan",
"SLPI": "Payment Slip Instruction",
"SPLT": "Split payments",
"SPSP": "SalaryPensionSumPayment",
"SRAG": "Purchase or sale of services estate agency",
"SSBE": "Social Security Benefit",
"STDY": "Study",
"SUBS": "Subscription",
"SUPP": "Supplier Payment",
"SWBC": "Swap Broker owned cash collateral",
"SWCC": "Swap Client owned cash collateral",
"SWFP": "Swap contract final payment",
"SWPP": "Swap contract partial payment",
"SWPT": "Swaption",
"SWRS": "Swap contract reset payment",
"SWSB": "Swaps Broker Owned Segregated Cash Collateral",
"SWSC": "Swaps Client Owned Segregated Cash Collateral",
"SWUF": "Swap contract upfront payment",
"TAXR": "Tax Refund",
"TAXS": "Tax Payment",
"TBAN": "TBA pair-off netting",
"TBAS": "To Be Announced",
"TBBC": "TBA Broker owned cash collateral",
"TBCC": "TBA Client owned cash collateral",
"TBIL": "Telecommunications Bill",
"TCSC": "Town Council Service Charges",
"TELI": "Telephone-Initiated Transaction",
"TLRF": "Non-US mutual fund trailer fee payment",
"TLRR": "Non-US mutual fund trailer fee rebate payment",
"TMPG": "TMPG claim payment",
"TPRI": "Tri Party Repo Interest",
"TPRP": "Tri-party Repo netting",
"TRAD": "Trade Services",
"TRCP": "Treasury Cross Product",
"TREA": "Treasury Payment",
"TRFD": "Trust Fund",
"TRNC": "Truncated Payment Slip",
"TRPT": "Road Pricing",
"TRVC": "Traveller Cheque",
"UBIL": "Utilities",
"UNIT": "Unit Trust Purchase",
"VATX": "Value Added Tax Payment",
"VIEW": "Vision Care",
"WEBI": "Internet-Initiated Transaction",
"WHLD": "With Holding",
"WTER": "Water Bill"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"RgltryRptg": {
"type": "object",
"title": "Regulatory Reporting Information",
"description": "Information needed due to regulatory and statutory requirements.",
"properties": {
"DbtCdtRptgInd": {
"type": "string",
"description": "Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.",
"minItems": 1,
"maxItems": 1,
"enum": [
"CRED",
"DEBT",
"BOTH"
],
"x-enumDescriptions": {
"CRED": "Credit",
"DEBT": "Debit",
"BOTH": "Both"
}
},
"Authrty": {
"type": "object",
"description": "Entity requiring the regulatory reporting information.",
"properties": {
"Nm": {
"type": "string",
"description": "Name of the entity requiring the regulatory reporting information.",
"maxLength": 140
},
"Ctry": {
"type": "string",
"description": "Country where Entity resides. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list.",
"pattern": "^[A-Z]{2}$"
}
}
},
"Dtls": {
"type": "object",
"description": "Set of elements used to provide details on the regulatory reporting information.",
"properties": {
"Tp": {
"type": "string",
"description": "Specifies the type of the information supplied in the regulatory reporting details.",
"maxLength": 35
},
"Dt": {
"type": "string",
"description": "Date related to the specified type of regulatory reporting details.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"Ctry": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1 list](https://www.iso.org/obp/ui/#search)."
},
"Cd": {
"type": "string",
"description": "Specifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.",
"maxLength": 10
},
"Amt": {
"type": "object",
"description": "Amount of money to be reported for regulatory and statutory requirements.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"Ccy": {
"type": "string",
"pattern": "^[A-Z]{3,3}$",
"description": "Code allocated to identify a currency."
}
}
},
"Inf": {
"type": "string",
"description": "Additional details that cater for specific domestic regulatory requirements.",
"maxLength": 35
}
}
}
}
},
"RltdRmtInf": {
"type": "object",
"title": "Related Remittance Information",
"description": "Provides information related to the handling of the remittance information by any of the agents in the transaction processing chain.",
"properties": {
"RmtId": {
"type": "string",
"description": "Unique identification, as assigned by the initiating party, to unambiguously identify the remittance information sent separately from the payment instruction, such as a remittance advice.",
"maxLength": 35
},
"RmtLctnDtls": {
"type": "object",
"description": "Set of elements used to provide information on the location and/or delivery of the remittance information.",
"properties": {
"Mtd": {
"type": "string",
"description": "List based on ISO 20022 RemittanceLocationMethod2Code List",
"enum": [
"FAXI",
"EDIC",
"URID",
"EMAL",
"POST",
"SMSM"
],
"x-enumDescriptions": {
"FAXI": "Fax",
"EDIC": "Electronic Data Interchange",
"URID": "Uniform Resource Identifier",
"EMAL": "EMail",
"POST": "Post",
"SMSM": "SMS"
}
},
"ElctrncAdr": {
"type": "string",
"description": "Electronic address to which an agent is to send the remittance information.",
"maxLength": 2048
},
"PstlAdr": {
"type": "object",
"description": "Postal address to which an agent is to send the remittance information.",
"properties": {
"Nm": {
"description": "Name by which the party is known and which is usually used to identify the party.<br/><ul><li>Must include one (1) name string.<li>Allowable characters: Alphanumeric and space.<li>Names with multiple words must be separated by a space.<li>For example, specify \"Widgets Org\", as `Widgets Org`.<li>Provide a truncated name if longer than 140 characters.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 140
},
"Adr": {
"type": "object",
"description": "Address for the party or organization.",
"properties": {
"AdrTp": {
"type": "string",
"description": "Specifies the type of address based on the [ISO20022 AddressType1Code](https://www.iso20022.org/standardsrepository/type/AddressType1Code) list",
"minItems": 1,
"maxItems": 1,
"enum": [
"ADDR",
"PBOX",
"HOME",
"BIZZ",
"MLTO",
"DLVY"
],
"x-enumDescriptions": {
"ADDR": "Postal",
"PBOX": "PO Box",
"HOME": "Residential",
"BIZZ": "Business",
"MLTO": "Mail To",
"DLVY": "Delivery To"
}
},
"AdrLine": {
"description": "Information that locates and identifies the address for the party.",
"type": "array",
"maxLength": 70
},
"Dept": {
"description": "Information that locates and identifies the department for the party.",
"type": "string",
"maxLength": 70
},
"SubDept": {
"description": "Information that locates and identifies the sub department for the party.",
"type": "string",
"maxLength": 70
},
"StrtNm": {
"description": "Information that locates and identifies the street name for the party, as defined by postal services.",
"type": "string",
"maxLength": 70
},
"BldgNb": {
"description": "Information that locates and identifies the building number for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"PstCd": {
"description": "Information that locates and identifies postal code for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"TwnNm": {
"description": "Information that locates and identifies the city / town for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"CtrySubDvsn": {
"description": "Information that locates and identifies the state / county for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"Ctry": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country for the party, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list."
}
}
}
}
}
}
}
}
},
"RmtInf": {
"type": "object",
"title": "Remittance Information",
"description": "Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.",
"required": [
"Ustrd"
],
"properties": {
"Ustrd": {
"description": "Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. This is additional remittance information that the debtor wants to provide the creditor.<br/><br/><b>Usage Guidelines</b>:<br/><li>When required and possible, this information must be forwarded to the Creditor over local clearing channels.<li>You can also use this field to specify descriptive information about the purpose of the payment.<li>Should new lines be required in this field, use `\\n` to denote a new line.<li>Truncate the string if value exceeds 140 characters.<li>If no known remittance information is available, specify `NOTPROVIDED`. Do not use this string if additional information is available and can be specified.<li>An example of a valid string:<br/><br/><b>Example</b>: `LEGAL INVOICE NO. PAY/X/2016/344129345/101`",
"type": "string",
"maxLength": 140
},
"Strd": {
"type": "object",
"description": "Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in a structured form.",
"properties": {
"RfrdDocInf": {
"type": "object",
"description": "Provides the identification and the content of the referred document.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of referred document.",
"properties": {
"CdOrPrtry": {
"type": "object",
"description": "Provides the type details of the referred document.",
"properties": {
"Cd": {
"type": "string",
"description": "Document type in a coded form. As defined in ISO list DocumentType6Code ",
"enum": [
"MSIN",
"CNFA",
"DNFA",
"CINV",
"CREN",
"DEBN",
"HIRI",
"SBIN",
"CMCN",
"SOAC",
"DISP",
"BOLD",
"VCHR",
"AROI",
"TSUT",
"PUOR"
],
"x-enumDescriptions": {
"MSIN": "Metered Service Invoice",
"CNFA": "Credit Note Related To Financial Adjustment",
"DNFA": "Debit Note Related To Financial Adjustment",
"CINV": "Commercial Invoice",
"CREN": "Credit Note",
"DEBN": "Debit Note",
"HIRI": "Hire Invoice",
"SBIN": "Self Billed Invoice",
"CMCN": "Commercial Contract",
"SOAC": "Statement Of Account",
"DISP": "Dispatch Advice",
"BOLD": "Bill Of Lading",
"VCHR": "Voucher",
"AROI": "Account Receivable Open Item",
"TSUT": "Trade Services Utility Transaction",
"PUOR": "Purchase Order"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary values",
"maxLength": 35
}
},
"Issr": {
"type": "string",
"description": "Identification of the issuer of the reference document type.",
"maxLength": 35
}
}
}
},
"Nb": {
"type": "string",
"description": "Unique and unambiguous identification of the referred document.",
"maxLength": 35
},
"RltdDt": {
"type": "string",
"description": "Date associated with the referred document.",
"format": "date"
},
"LineDtls": {
"type": "array",
"description": "Set of elements used to provide the content of the referred document line.",
"items": [
{
"type": "object",
"properties": {
"Id": {
"type": "object",
"description": "Provides identification of the document line.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of referred document line identification.",
"properties": {
"CdOrPrtry": {
"type": "object",
"description": "Provides the type details of the referred document line identification.",
"properties": {
"Cd": {
"type": "string",
"description": "Line identification type in a coded form. Uses ISO list ExternalDocumentLineType1Code",
"enum": [
"ADPI",
"AISB",
"ASNB",
"CTNB",
"DBSP",
"EANN",
"EINB",
"GSNB",
"HIBC",
"ISBN",
"LTNB",
"MDNB",
"PRNB",
"PTCD",
"SKNB",
"STNB",
"TONB",
"UPCC",
"UPNB"
],
"x-enumDescriptions": {
"ADPI": "Additional Product Identification Assigned by the Manufacturer. Line item Reference is an additional product identification assigned by the manufacturer.",
"AISB": "Alternate ISBN. Line item Reference is an alternate International Standard Book Number (ISBN).",
"ASNB": "Asset Number. Line item Reference is an asset number.",
"CTNB": "Catalog Number. Line item Reference is a catalog number.",
"DBSP": "Dun & Bradstreet Standard Product and Service Code. Line item Reference is Dun & Bradstreet Standard Product and Service code.",
"EANN": "European Article Number (EAN) (2-5-5-1). Line item Reference is an European Article Number (EAN).",
"EINB": "Equipment Identification Number. Line item Reference is an equipment identification number.",
"GSNB": "General Specification Number. Line item Reference is a general specification number.",
"HIBC": "HIBC (Health Care Industry Bar Code). Line item Reference is a Health Care Industry Bar Code (HIBC)",
"ISBN": "International Standard Book Number (ISBN). Line item Reference is an International Standard Book Number (ISBN).",
"LTNB": "Lot Number. Line item Reference is a lot number.",
"MDNB": "Model Number. Line item Reference is a model number.",
"PRNB": "Part Number. Line item Reference is a part Reference number.",
"PTCD": "Product Type Code. Line item Reference is a product type code.",
"SKNB": "Stock Number. Line item Reference is a stock number.",
"STNB": "Style Number. Line item Reference is a style number.",
"TONB": "Technical Order Number. Line item Reference is a technical order number.",
"UPCC": "UPC Consumer Package Code. Line item Reference is an UPC consumer package code.",
"UPNB": "Universal Product Number. Line item Reference is an Universal Product Number."
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"Issr": {
"type": "string",
"description": "Identification of the issuer of the reference document line identification type.",
"maxLength": 35
}
}
},
"Nb": {
"type": "string",
"description": "Identification of the type specified for the referred document line.",
"maxLength": 35
},
"RltdDt": {
"type": "string",
"description": "Date associated with the referred document line.",
"format": "date"
}
}
},
"Desc": {
"type": "string",
"description": "Description associated with the document line.",
"maxLength": 2048
},
"Amt": {
"type": "object",
"description": "Provides details on the amounts of the document line.",
"properties": {
"DuePyblAmt": {
"type": "object",
"description": "Amount specified is the exact amount due and payable to the creditor.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3,3}$",
"description": "Code allocated to identify a currency."
}
}
},
"DscntApldAmt": {
"type": "object",
"description": "Amount of discount to be applied to the amount due and payable to the creditor.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of the amount.",
"properties": {
"Cd": {
"type": "string",
"description": "Specifies the amount type, in a coded form. Based on ISO list ExternalDiscountAmountType1Code",
"enum": [
"APDS",
"STDS",
"TMDS"
],
"x-enumDescriptions": {
"APDS": "Additional Promotional Discount",
"STDS": "Standing Discount",
"TMDS": "Terms Discount"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"Amt": {
"type": "object",
"description": "Amount of money, which has been typed",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3,3}$",
"description": "Code allocated to identify a currency."
}
}
}
}
},
"CdtNoteAmt": {
"type": "object",
"description": "Amount of a credit note.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3,3}$",
"description": "Code allocated to identify a currency."
}
}
},
"TaxAmt": {
"type": "object",
"description": "Amount of the tax.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of the amount.",
"properties": {
"Cd": {
"type": "string",
"description": "Specifies the amount type, in a coded form. Based on ISO ExternalTaxAmountType1Code list",
"enum": [
"CITY",
"CNTY",
"LOCL",
"PROV",
"STAT"
],
"x-enumDescriptions": {
"CITY": "City Tax",
"CNTY": "County Tax",
"LOCL": "Local Tax",
"PROV": "Province Tax",
"STAT": "State Tax"
}
},
"Prtry": {
"type": "string",
"description": "Specifies the amount type, in a free-text form.",
"maxLength": 35
}
}
},
"Amt": {
"type": "object",
"description": "Amount of money, which has been typed",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3,3}$",
"description": "Code allocated to identify a currency."
}
}
}
}
},
"AdjstmntAmtAndRsn": {
"type": "object",
"description": "Specifies detailed information on the amount and reason for the adjustment.",
"properties": {
"Amt": {
"type": "object",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3,3}$",
"description": "Code allocated to identify a currency."
}
}
},
"CdtDbtInd": {
"type": "string",
"description": "Specifies whether the adjustment must be subtracted or added to the total amount.",
"enum": [
"CRDT",
"DBIT"
],
"x-enumDescriptions": {
"CRDT": "Credit",
"DBIT": "Debit"
}
},
"Rsn": {
"type": "string",
"description": "Specifies the reason for the adjustment.",
"maxLength": 4
},
"AddtlInf": {
"type": "string",
"description": "Provides further details on the document adjustment.",
"maxLength": 140
}
}
},
"RmtdAmt": {
"type": "object",
"description": "Amount of money remitted.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3,3}$",
"description": "Code allocated to identify a currency."
}
}
}
}
}
}
}
]
}
}
},
"RfrdDocAmt": {
"type": "object",
"description": "Provides details on the amounts of the referred document.",
"properties": {
"DuePyblAmt": {
"type": "object",
"description": "Amount specified is the exact amount due and payable to the creditor.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3,3}$",
"description": "Code allocated to identify a currency."
}
}
},
"DscntApldAmt": {
"type": "object",
"description": "Amount specified for the referred document is the amount of discount to be applied to the amount due and payable to the creditor.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of the amount.",
"properties": {
"Cd": {
"type": "string",
"description": "Specifies the amount type, in a coded form. Based on ISO ExternalDiscountAmountType1Code",
"enum": [
"APDS",
"STDS",
"TMDS"
],
"x-enumDescriptions": {
"APDS": "Additional Promotional Discount",
"STDS": "Standing Discount",
"TMDS": "Terms Discount"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"Amt": {
"type": "object",
"description": "Amount of money, which has been typed.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3,3}$",
"description": "Code allocated to identify a currency."
}
}
}
}
},
"CdtNoteAmt": {
"type": "object",
"description": "Amount specified for the referred document is the amount of a credit note.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3,3}$",
"description": "Code allocated to identify a currency."
}
}
},
"TaxAmt": {
"type": "object",
"description": "Quantity of cash resulting from the calculation of the tax.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of the amount. Based on the ISO ExternalTaxAmountType1Code list",
"properties": {
"Cd": {
"type": "string",
"description": "Specifies the amount type, in a coded form. Based on the ISO ExternalTaxAmountType1Code list",
"enum": [
"CITY",
"CNTY",
"LOCL",
"PROV",
"STAT"
],
"x-enumDescriptions": {
"CITY": "City Tax",
"CNTY": "County Tax",
"LOCL": "Local Tax",
"PROV": "Province Tax",
"STAT": "State Tax"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"Amt": {
"type": "object",
"description": "Amount of money, which has been typed.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3,3}$",
"description": "Code allocated to identify a currency."
}
}
}
}
},
"AdjstmntAmtAndRsn": {
"type": "object",
"description": "Specifies detailed information on the amount and reason of the document adjustment.",
"properties": {
"Amt": {
"type": "object",
"description": "Amount of money of the document adjustment.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3,3}$",
"description": "Code allocated to identify a currency."
}
}
},
"CdtDbtInd": {
"type": "string",
"description": "Specifies whether the adjustment must be substracted or added to the total amount.",
"enum": [
"CRDT",
"DBIT"
],
"x-enumDescriptions": {
"CRDT": "Credit",
"DBIT": "Debit"
}
},
"Rsn": {
"type": "string",
"description": "Specifies the reason for the adjustment.",
"maxLength": 4
},
"AddtlInf": {
"type": "string",
"description": "Provides further details on the document adjustment.",
"maxLength": 140
}
}
},
"RmtdAmt": {
"type": "object",
"description": "Amount of money remitted for the referred document.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3,3}$",
"description": "Code allocated to identify a currency."
}
}
}
}
},
"CdtrRefInf": {
"type": "object",
"description": "Reference information provided by the creditor to allow the identification of the underlying documents.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of creditor reference.",
"properties": {
"CdOrPrtry": {
"type": "object",
"description": "Coded or proprietary format creditor reference type.",
"properties": {
"Cd": {
"type": "string",
"description": "Type of creditor reference, in a coded form. Based on ISO DocumentType3Code list",
"enum": [
"RADM",
"RPIN",
"FXDR",
"DISP",
"PUOR",
"SCOR"
],
"x-enumDescriptions": {
"RADM": "Remittance Advice Message",
"RPIN": "Related Payment Instruction",
"FXDR": "Foreign Exchange Deal Reference",
"DISP": "Dispatch Advice",
"PUOR": "Purchase Order",
"SCOR": "Structured Communication Reference"
}
},
"Prtry": {
"type": "string",
"description": "Creditor reference type, in a proprietary form.",
"maxLength": 35
}
}
},
"Issr": {
"type": "string",
"description": "Entity that assigns the credit reference type.",
"maxLength": 35
}
}
},
"Ref": {
"type": "string",
"description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.",
"maxLength": 35
}
}
},
"Invcr": {
"type": "object",
"description": "Identification of the organization issuing the invoice, when it is different from the creditor or ultimate creditor.",
"properties": {
"Nm": {
"description": "Name by which the party is known and which is usually used to identify the party.<br/><ul><li>Must include one (1) name string.<li>Allowable characters: Alphanumeric and space.<li>Names with multiple words must be separated by a space.<li>For example, specify \"Widgets Org\", as `Widgets Org`.<li>Provide a truncated name if longer than 140 characters.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 140
},
"StrdNm": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>Allowable characters: Alphanumeric and space.<li>If the name has multiple words, separate them by a space.<li>Provide a truncated name if longer than allowable characters.",
"required": [
"FirstNm",
"LastNm"
],
"properties": {
"FirstNm": {
"description": "First name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the first name has two or more words, separate them with a space.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.<li>Provide a truncated name if longer than allowable characters.</ul><b>Example</b></br><ul><li>If the party's full name is 'Norma-Jean Baker' where 'Norma-Jean' is the first name, the `StrdNm.FirstNm` value must be 'Norma Jean'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"MidNm": {
"description": "Middle name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm": {
"description": "Last name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the last name has two or more words, separate them with a space.<li>Provide a truncated name if longer than allowable characters.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.</ul><b>Example</b></br><ul><li>If the party's full name is 'Enrique Miguel Iglesias Preysler,' where 'Iglesias Preysler' is the last name, the `StrdNm.LastNm` value must be 'Iglesias Preysler'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm2": {
"description": "Secondary last name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"NtrlNm": {
"description": "Name in local character set or language.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Title": {
"description": "Title by which the party is known and which is usually used to identify the party.",
"type": "string",
"minLength": 1,
"maxLength": 20
}
}
},
"CtryOfRes": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1 list](https://www.iso.org/obp/ui/#search)."
},
"PstlAdr": {
"type": "object",
"description": "Address for the party or organization.",
"properties": {
"AdrTp": {
"type": "string",
"description": "Specifies the type of address based on the [ISO20022 AddressType1Code](https://www.iso20022.org/standardsrepository/type/AddressType1Code) list",
"minItems": 1,
"maxItems": 1,
"enum": [
"ADDR",
"PBOX",
"HOME",
"BIZZ",
"MLTO",
"DLVY"
],
"x-enumDescriptions": {
"ADDR": "Postal",
"PBOX": "PO Box",
"HOME": "Residential",
"BIZZ": "Business",
"MLTO": "Mail To",
"DLVY": "Delivery To"
}
},
"AdrLine": {
"description": "Information that locates and identifies the address for the party.",
"type": "array",
"maxLength": 70
},
"Dept": {
"description": "Information that locates and identifies the department for the party.",
"type": "string",
"maxLength": 70
},
"SubDept": {
"description": "Information that locates and identifies the sub department for the party.",
"type": "string",
"maxLength": 70
},
"StrtNm": {
"description": "Information that locates and identifies the street name for the party, as defined by postal services.",
"type": "string",
"maxLength": 70
},
"BldgNb": {
"description": "Information that locates and identifies the building number for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"PstCd": {
"description": "Information that locates and identifies postal code for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"TwnNm": {
"description": "Information that locates and identifies the city / town for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"CtrySubDvsn": {
"description": "Information that locates and identifies the state / county for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"Ctry": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country for the party, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list."
}
}
},
"Id": {
"type": "object",
"description": "Unique and unambiguous way to identify an individual or organization.",
"properties": {
"OrgId": {
"type": "object",
"description": "Unique and unambiguous way to identify an individual or organization.",
"properties": {
"AnyBIC": {
"type": "string",
"pattern": "^([a-zA-Z0-9_-]){8,11}$",
"description": "The Business identifier code (BIC) allocated to a receiving institution by the [ISO 9362 Registration Authority](https://www.iso.org/standard/84108.html).<br/><br/><b>Example</b>: `BANKGB22`"
},
"DtAndPlcofIncorprtn": {
"type": "object",
"description": "<b>[Soft field](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the organization's date and place of incorporation.",
"properties": {
"DtofIncorprtn": {
"type": "string",
"description": "The date of incorporation for the organization.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"CtryofIncorprtn": {
"type": "string",
"description": "Information that locates and identifies the country, as defined by postal services where the organization was incorporated. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.",
"pattern": "^[A-Z]{2}"
}
}
},
"Othr": {
"type": "array",
"description": "An array of objects, each containing unique identification of an organization, as assigned by an institution, using an identification scheme.",
"items": {
"type": "object",
"properties": {
"Id": {
"description": "Identification assigned by an institution.",
"type": "string",
"maxLength": 35
},
"Issr": {
"description": "Entity that assigns the identification.",
"type": "string",
"maxLength": 35
},
"DtOfIsse": {
"description": "The date of issuance of the supporting documentation.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"DtOfXpry": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>The date of expiration of the supporting documentation.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"SchmeNm": {
"type": "object",
"description": "Name of the organization identification scheme.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ExternalorganizationIdentification1Code List",
"enum": [
"BANK",
"CBID",
"CHID",
"CINC",
"COID",
"CUST",
"DUNS",
"EMPL",
"GS1G",
"SREN",
"SRET",
"TXID",
"USCC"
],
"x-enumDescriptions": {
"BANK": "Bank Party Identification",
"CBID": "Central Bank Identification Number",
"CHID": "Clearing Identification Number",
"CINC": "Certificate Of Incorporation Number",
"COID": "Country Identification Code",
"CUST": "Customer Number",
"DUNS": "Data Universal Numbering System",
"EMPL": "Employer Identification Number",
"GS1G": "GS1GLN Identifier",
"SREN": "SIREN",
"SRET": "SIRET",
"TXID": "Tax Identification Number",
"USCC": "Unified Social Credit Code"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
}
}
}
},
"RelShipToDbtr": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the relationship between the Sender and Receiver.",
"enum": [
"BRAN",
"CUST",
"FRAN",
"HOLD",
"PART",
"SUBS",
"SUPP"
],
"x-enumDescriptions": {
"BRAN": "Branch or representative office",
"CUST": "Customer",
"FRAN": "Franchisee or franchisor",
"HOLD": "Holding company",
"PART": "Business partner",
"SUBS": "Subsidiary company",
"SUPP": "Supplier"
}
},
"RelShipToCdtr": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the relationship between the Sender and Receiver.",
"enum": [
"BRAN",
"CUST",
"FRAN",
"HOLD",
"PART",
"SUBS",
"SUPP"
],
"x-enumDescriptions": {
"BRAN": "Branch or representative office",
"CUST": "Customer",
"FRAN": "Franchisee or franchisor",
"HOLD": "Holding company",
"PART": "Business partner",
"SUBS": "Subsidiary company",
"SUPP": "Supplier"
}
},
"Rprtv": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the name of the organization's representative.",
"properties": {
"StrdNm": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Allows the name of the organization's representative to be held in a structured format.",
"required": [
"FirstNm",
"LastNm"
],
"properties": {
"FirstNm": {
"description": "First name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the first name has two or more words, separate them with a space.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.<li>Provide a truncated name if longer than allowable characters.</ul><b>Example</b></br><ul><li>If the party's full name is 'Norma-Jean Baker' where 'Norma-Jean' is the first name, the `StrdNm.FirstNm` value must be 'Norma Jean'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"MidNm": {
"description": "Middle name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm": {
"description": "Last name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the last name has two or more words, separate them with a space.<li>Provide a truncated name if longer than allowable characters.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.</ul><b>Example</b></br><ul><li>If the party's full name is 'Enrique Miguel Iglesias Preysler,' where 'Iglesias Preysler' is the last name, the `StrdNm.LastNm` value must be 'Iglesias Preysler'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm2": {
"description": "Secondary last name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"NtrlNm": {
"description": "Name in local character set or language.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Title": {
"description": "Title by which the party is known and which is usually used to identify the party.",
"type": "string",
"minLength": 1,
"maxLength": 20
}
}
}
}
}
}
},
"PrvtId": {
"type": "object",
"description": "Unique and unambiguous identification of a person, e.g., passport.",
"properties": {
"DtAndPlcOfBirth": {
"type": "object",
"description": "Date and place of birth of a person.",
"properties": {
"BirthDt": {
"description": "Information that identifies the date of Birth for the party.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"PrvcOfBirth": {
"description": "Information that locates and identifies the Province of birth for the party.",
"type": "string",
"maxLength": 35
},
"CityOfBirth": {
"description": "Information that locates and identifies the city of birth for the party.",
"type": "string",
"maxLength": 35
},
"CtryOfBirth": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country of birth for the party, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list."
}
}
},
"Othr": {
"type": "array",
"description": "An array of objects, each containing the unique identification of a party, as assigned by an institution, using an identification scheme.",
"items": {
"type": "object",
"properties": {
"Id": {
"description": "Value to be used to identify the party",
"type": "string",
"maxLength": 35
},
"Issr": {
"description": "Information for the Entity that assigns the identification.",
"type": "string",
"maxLength": 35
},
"SchmeNm": {
"type": "object",
"description": "Name of the identification scheme used to identify an individual.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ISO20022 ExternalPersonIdentification1Code List ",
"enum": [
"ARNU",
"CCPT",
"CUST",
"DRLC",
"EMPL",
"NIDN",
"SOS",
"TELE",
"TXID"
],
"x-enumDescriptions": {
"ARNU": "Alien Registration Number",
"CCPT": "Passport Number",
"CUST": "Customer Identification Number",
"DRLC": "Drivers License Number",
"EMPL": "Employee Identification Number",
"NIDN": "National Identity Number",
"SOS": "Social Security Number",
"TELE": "Telephone Number",
"TXID": "Tax Identification Number"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"DtOfIss": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Issue date of the ID.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"DtOfXpry": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Expiry date of the ID.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"MrzNb": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Machine Readable Zone for Passport. This field only applies if the ID is a passport.",
"type": "string",
"maxLength": 88,
"pattern": "^[A-Z<]{1}[A-Z0-9<]{1}[A-Z<]{3}[0-9<]{6}[A0-9<]{1}[0-9<]{1}[A0-9<]{7}[A-Z<]{1}[0-9<]{1}[0-9<]{3}[A0-9<]{1}[0-9<]{1}[A0-9<]{7}[0-9<]{14}$"
}
}
}
},
"Gndr": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Information that captures the Gender of a party.",
"type": "string",
"maxLength": 6,
"enum": [
"Male",
"Female",
"Other"
],
"x-enumDescriptions": {
"Male": "Male",
"Female": "Female",
"Other": "Other"
}
},
"Prfssn": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Information that captures the occupation of a party.",
"type": "string",
"maxLength": 35
},
"RelShipToDbtr": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Relationship of the receiving party to the sending party.<br/><strong>Note</strong>: This information is required within the creditor object `cdtr` for payout in the Philippines.",
"type": "string",
"enum": [
"CHIL",
"CUST",
"EMPL",
"EXSP",
"FREN",
"OTHR",
"PARE",
"PART",
"RELA",
"SELF",
"SIBL",
"SPOU",
"VEND"
],
"x-enumDescriptions": {
"CHIL": "Child",
"CUST": "Customer",
"EMPL": "Employee",
"EXSP": "Ex-spouse",
"FREN": "Friend",
"OTHR": "Other",
"PARE": "Parent",
"PART": "Business partner",
"RELA": "Relation",
"SELF": "Self",
"SIBL": "Sibling",
"SPOU": "Covering Spouse/Partner",
"VEND": "Vendor"
}
},
"RelShipToCdtr": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Relationship of the receiving party to the sending party.<br/><strong>Note</strong>: This information is required within the creditor object `cdtr` for payout in the Philippines.",
"type": "string",
"enum": [
"CHIL",
"CUST",
"EMPL",
"EXSP",
"FREN",
"OTHR",
"PARE",
"PART",
"RELA",
"SELF",
"SIBL",
"SPOU",
"VEND"
],
"x-enumDescriptions": {
"CHIL": "Child",
"CUST": "Customer",
"EMPL": "Employee",
"EXSP": "Ex-spouse",
"FREN": "Friend",
"OTHR": "Other",
"PARE": "Parent",
"PART": "Business partner",
"RELA": "Relation",
"SELF": "Self",
"SIBL": "Sibling",
"SPOU": "Covering Spouse/Partner",
"VEND": "Vendor"
}
},
"Ntlty": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>ISO country code of nationality of the party.",
"maxLength": 3
},
"Residence": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Country of residence of the party. Use ISO Country Code for value.",
"maxLength": 3
},
"Ctznsh": {
"type": "object",
"properties": {
"Ntlty": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Nationality of the party. Use ISO Country Code for values.",
"maxLength": 3
},
"MnrId": {
"description": "Indicates whether the party is a minor.",
"type": "string",
"enum": [
"YES",
"NO"
],
"x-enumDescriptions": {
"YES": "Party is a minor.",
"NO": "Party is not a minor."
}
},
"StartDt": {
"description": "Start date of citizenship for the party.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"EndDt": {
"description": "End date of citizenship for the party.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
}
}
}
}
}
}
},
"CtctDtls": {
"type": "object",
"description": "Contact Details for the individual or organization",
"properties": {
"NmPrfx": {
"type": "string",
"description": "List based on ISO 20022 NamePrefix1Code List",
"enum": [
"DOCT",
"MIST",
"MISS",
"MADM"
],
"x-enumDescriptions": {
"DOCT": "Doctor",
"MIST": "Mister",
"MISS": "Miss",
"MADM": "Madam"
}
},
"Nm": {
"type": "string",
"description": "Name by which a party is known and which is usually used to identify that party.",
"maxLength": 140
},
"PhneNb": {
"type": "string",
"description": "Phone Number",
"maxLength": 15,
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"MobNb": {
"type": "string",
"description": "Mobile Phone Number",
"maxLength": 15,
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"FaxNb": {
"type": "string",
"description": "Fax Number",
"maxLength": 15,
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"EmailAdr": {
"type": "string",
"description": "Address for electronic mail (e-mail).",
"format": "email",
"maxLength": 2048
},
"Othr": {
"type": "string",
"description": "Contact details in another form.",
"maxLength": 35
}
}
}
}
},
"Invcee": {
"type": "object",
"description": "Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.",
"properties": {
"Nm": {
"description": "Name by which the party is known and which is usually used to identify the party.<br/><ul><li>Must include one (1) name string.<li>Allowable characters: Alphanumeric and space.<li>Names with multiple words must be separated by a space.<li>For example, specify \"Widgets Org\", as `Widgets Org`.<li>Provide a truncated name if longer than 140 characters.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 140
},
"StrdNm": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>Allowable characters: Alphanumeric and space.<li>If the name has multiple words, separate them by a space.<li>Provide a truncated name if longer than allowable characters.",
"required": [
"FirstNm",
"LastNm"
],
"properties": {
"FirstNm": {
"description": "First name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the first name has two or more words, separate them with a space.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.<li>Provide a truncated name if longer than allowable characters.</ul><b>Example</b></br><ul><li>If the party's full name is 'Norma-Jean Baker' where 'Norma-Jean' is the first name, the `StrdNm.FirstNm` value must be 'Norma Jean'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"MidNm": {
"description": "Middle name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm": {
"description": "Last name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the last name has two or more words, separate them with a space.<li>Provide a truncated name if longer than allowable characters.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.</ul><b>Example</b></br><ul><li>If the party's full name is 'Enrique Miguel Iglesias Preysler,' where 'Iglesias Preysler' is the last name, the `StrdNm.LastNm` value must be 'Iglesias Preysler'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm2": {
"description": "Secondary last name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"NtrlNm": {
"description": "Name in local character set or language.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Title": {
"description": "Title by which the party is known and which is usually used to identify the party.",
"type": "string",
"minLength": 1,
"maxLength": 20
}
}
},
"CtryOfRes": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1 list](https://www.iso.org/obp/ui/#search)."
},
"PstlAdr": {
"type": "object",
"description": "Address for the party or organization.",
"properties": {
"AdrTp": {
"type": "string",
"description": "Specifies the type of address based on the [ISO20022 AddressType1Code](https://www.iso20022.org/standardsrepository/type/AddressType1Code) list",
"minItems": 1,
"maxItems": 1,
"enum": [
"ADDR",
"PBOX",
"HOME",
"BIZZ",
"MLTO",
"DLVY"
],
"x-enumDescriptions": {
"ADDR": "Postal",
"PBOX": "PO Box",
"HOME": "Residential",
"BIZZ": "Business",
"MLTO": "Mail To",
"DLVY": "Delivery To"
}
},
"AdrLine": {
"description": "Information that locates and identifies the address for the party.",
"type": "array",
"maxLength": 70
},
"Dept": {
"description": "Information that locates and identifies the department for the party.",
"type": "string",
"maxLength": 70
},
"SubDept": {
"description": "Information that locates and identifies the sub department for the party.",
"type": "string",
"maxLength": 70
},
"StrtNm": {
"description": "Information that locates and identifies the street name for the party, as defined by postal services.",
"type": "string",
"maxLength": 70
},
"BldgNb": {
"description": "Information that locates and identifies the building number for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"PstCd": {
"description": "Information that locates and identifies postal code for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"TwnNm": {
"description": "Information that locates and identifies the city / town for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"CtrySubDvsn": {
"description": "Information that locates and identifies the state / county for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"Ctry": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country for the party, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list."
}
}
},
"Id": {
"type": "object",
"description": "Unique and unambiguous way to identify an individual or organization.",
"properties": {
"OrgId": {
"type": "object",
"description": "Unique and unambiguous way to identify an individual or organization.",
"properties": {
"AnyBIC": {
"type": "string",
"pattern": "^([a-zA-Z0-9_-]){8,11}$",
"description": "The Business identifier code (BIC) allocated to a receiving institution by the [ISO 9362 Registration Authority](https://www.iso.org/standard/84108.html).<br/><br/><b>Example</b>: `BANKGB22`"
},
"DtAndPlcofIncorprtn": {
"type": "object",
"description": "<b>[Soft field](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the organization's date and place of incorporation.",
"properties": {
"DtofIncorprtn": {
"type": "string",
"description": "The date of incorporation for the organization.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"CtryofIncorprtn": {
"type": "string",
"description": "Information that locates and identifies the country, as defined by postal services where the organization was incorporated. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.",
"pattern": "^[A-Z]{2}"
}
}
},
"Othr": {
"type": "array",
"description": "An array of objects, each containing unique identification of an organization, as assigned by an institution, using an identification scheme.",
"items": {
"type": "object",
"properties": {
"Id": {
"description": "Identification assigned by an institution.",
"type": "string",
"maxLength": 35
},
"Issr": {
"description": "Entity that assigns the identification.",
"type": "string",
"maxLength": 35
},
"DtOfIsse": {
"description": "The date of issuance of the supporting documentation.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"DtOfXpry": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>The date of expiration of the supporting documentation.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"SchmeNm": {
"type": "object",
"description": "Name of the organization identification scheme.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ExternalorganizationIdentification1Code List",
"enum": [
"BANK",
"CBID",
"CHID",
"CINC",
"COID",
"CUST",
"DUNS",
"EMPL",
"GS1G",
"SREN",
"SRET",
"TXID",
"USCC"
],
"x-enumDescriptions": {
"BANK": "Bank Party Identification",
"CBID": "Central Bank Identification Number",
"CHID": "Clearing Identification Number",
"CINC": "Certificate Of Incorporation Number",
"COID": "Country Identification Code",
"CUST": "Customer Number",
"DUNS": "Data Universal Numbering System",
"EMPL": "Employer Identification Number",
"GS1G": "GS1GLN Identifier",
"SREN": "SIREN",
"SRET": "SIRET",
"TXID": "Tax Identification Number",
"USCC": "Unified Social Credit Code"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
}
}
}
},
"RelShipToDbtr": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the relationship between the Sender and Receiver.",
"enum": [
"BRAN",
"CUST",
"FRAN",
"HOLD",
"PART",
"SUBS",
"SUPP"
],
"x-enumDescriptions": {
"BRAN": "Branch or representative office",
"CUST": "Customer",
"FRAN": "Franchisee or franchisor",
"HOLD": "Holding company",
"PART": "Business partner",
"SUBS": "Subsidiary company",
"SUPP": "Supplier"
}
},
"RelShipToCdtr": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the relationship between the Sender and Receiver.",
"enum": [
"BRAN",
"CUST",
"FRAN",
"HOLD",
"PART",
"SUBS",
"SUPP"
],
"x-enumDescriptions": {
"BRAN": "Branch or representative office",
"CUST": "Customer",
"FRAN": "Franchisee or franchisor",
"HOLD": "Holding company",
"PART": "Business partner",
"SUBS": "Subsidiary company",
"SUPP": "Supplier"
}
},
"Rprtv": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the name of the organization's representative.",
"properties": {
"StrdNm": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Allows the name of the organization's representative to be held in a structured format.",
"required": [
"FirstNm",
"LastNm"
],
"properties": {
"FirstNm": {
"description": "First name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the first name has two or more words, separate them with a space.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.<li>Provide a truncated name if longer than allowable characters.</ul><b>Example</b></br><ul><li>If the party's full name is 'Norma-Jean Baker' where 'Norma-Jean' is the first name, the `StrdNm.FirstNm` value must be 'Norma Jean'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"MidNm": {
"description": "Middle name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm": {
"description": "Last name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the last name has two or more words, separate them with a space.<li>Provide a truncated name if longer than allowable characters.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.</ul><b>Example</b></br><ul><li>If the party's full name is 'Enrique Miguel Iglesias Preysler,' where 'Iglesias Preysler' is the last name, the `StrdNm.LastNm` value must be 'Iglesias Preysler'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm2": {
"description": "Secondary last name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"NtrlNm": {
"description": "Name in local character set or language.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Title": {
"description": "Title by which the party is known and which is usually used to identify the party.",
"type": "string",
"minLength": 1,
"maxLength": 20
}
}
}
}
}
}
},
"PrvtId": {
"type": "object",
"description": "Unique and unambiguous identification of a person, e.g., passport.",
"properties": {
"DtAndPlcOfBirth": {
"type": "object",
"description": "Date and place of birth of a person.",
"properties": {
"BirthDt": {
"description": "Information that identifies the date of Birth for the party.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"PrvcOfBirth": {
"description": "Information that locates and identifies the Province of birth for the party.",
"type": "string",
"maxLength": 35
},
"CityOfBirth": {
"description": "Information that locates and identifies the city of birth for the party.",
"type": "string",
"maxLength": 35
},
"CtryOfBirth": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country of birth for the party, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list."
}
}
},
"Othr": {
"type": "array",
"description": "An array of objects, each containing the unique identification of a party, as assigned by an institution, using an identification scheme.",
"items": {
"type": "object",
"properties": {
"Id": {
"description": "Value to be used to identify the party",
"type": "string",
"maxLength": 35
},
"Issr": {
"description": "Information for the Entity that assigns the identification.",
"type": "string",
"maxLength": 35
},
"SchmeNm": {
"type": "object",
"description": "Name of the identification scheme used to identify an individual.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ISO20022 ExternalPersonIdentification1Code List ",
"enum": [
"ARNU",
"CCPT",
"CUST",
"DRLC",
"EMPL",
"NIDN",
"SOS",
"TELE",
"TXID"
],
"x-enumDescriptions": {
"ARNU": "Alien Registration Number",
"CCPT": "Passport Number",
"CUST": "Customer Identification Number",
"DRLC": "Drivers License Number",
"EMPL": "Employee Identification Number",
"NIDN": "National Identity Number",
"SOS": "Social Security Number",
"TELE": "Telephone Number",
"TXID": "Tax Identification Number"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"DtOfIss": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Issue date of the ID.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"DtOfXpry": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Expiry date of the ID.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"MrzNb": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Machine Readable Zone for Passport. This field only applies if the ID is a passport.",
"type": "string",
"maxLength": 88,
"pattern": "^[A-Z<]{1}[A-Z0-9<]{1}[A-Z<]{3}[0-9<]{6}[A0-9<]{1}[0-9<]{1}[A0-9<]{7}[A-Z<]{1}[0-9<]{1}[0-9<]{3}[A0-9<]{1}[0-9<]{1}[A0-9<]{7}[0-9<]{14}$"
}
}
}
},
"Gndr": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Information that captures the Gender of a party.",
"type": "string",
"maxLength": 6,
"enum": [
"Male",
"Female",
"Other"
],
"x-enumDescriptions": {
"Male": "Male",
"Female": "Female",
"Other": "Other"
}
},
"Prfssn": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Information that captures the occupation of a party.",
"type": "string",
"maxLength": 35
},
"RelShipToDbtr": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Relationship of the receiving party to the sending party.<br/><strong>Note</strong>: This information is required within the creditor object `cdtr` for payout in the Philippines.",
"type": "string",
"enum": [
"CHIL",
"CUST",
"EMPL",
"EXSP",
"FREN",
"OTHR",
"PARE",
"PART",
"RELA",
"SELF",
"SIBL",
"SPOU",
"VEND"
],
"x-enumDescriptions": {
"CHIL": "Child",
"CUST": "Customer",
"EMPL": "Employee",
"EXSP": "Ex-spouse",
"FREN": "Friend",
"OTHR": "Other",
"PARE": "Parent",
"PART": "Business partner",
"RELA": "Relation",
"SELF": "Self",
"SIBL": "Sibling",
"SPOU": "Covering Spouse/Partner",
"VEND": "Vendor"
}
},
"RelShipToCdtr": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Relationship of the receiving party to the sending party.<br/><strong>Note</strong>: This information is required within the creditor object `cdtr` for payout in the Philippines.",
"type": "string",
"enum": [
"CHIL",
"CUST",
"EMPL",
"EXSP",
"FREN",
"OTHR",
"PARE",
"PART",
"RELA",
"SELF",
"SIBL",
"SPOU",
"VEND"
],
"x-enumDescriptions": {
"CHIL": "Child",
"CUST": "Customer",
"EMPL": "Employee",
"EXSP": "Ex-spouse",
"FREN": "Friend",
"OTHR": "Other",
"PARE": "Parent",
"PART": "Business partner",
"RELA": "Relation",
"SELF": "Self",
"SIBL": "Sibling",
"SPOU": "Covering Spouse/Partner",
"VEND": "Vendor"
}
},
"Ntlty": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>ISO country code of nationality of the party.",
"maxLength": 3
},
"Residence": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Country of residence of the party. Use ISO Country Code for value.",
"maxLength": 3
},
"Ctznsh": {
"type": "object",
"properties": {
"Ntlty": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Nationality of the party. Use ISO Country Code for values.",
"maxLength": 3
},
"MnrId": {
"description": "Indicates whether the party is a minor.",
"type": "string",
"enum": [
"YES",
"NO"
],
"x-enumDescriptions": {
"YES": "Party is a minor.",
"NO": "Party is not a minor."
}
},
"StartDt": {
"description": "Start date of citizenship for the party.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"EndDt": {
"description": "End date of citizenship for the party.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
}
}
}
}
}
}
},
"CtctDtls": {
"type": "object",
"description": "Contact Details for the individual or organization",
"properties": {
"NmPrfx": {
"type": "string",
"description": "List based on ISO 20022 NamePrefix1Code List",
"enum": [
"DOCT",
"MIST",
"MISS",
"MADM"
],
"x-enumDescriptions": {
"DOCT": "Doctor",
"MIST": "Mister",
"MISS": "Miss",
"MADM": "Madam"
}
},
"Nm": {
"type": "string",
"description": "Name by which a party is known and which is usually used to identify that party.",
"maxLength": 140
},
"PhneNb": {
"type": "string",
"description": "Phone Number",
"maxLength": 15,
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"MobNb": {
"type": "string",
"description": "Mobile Phone Number",
"maxLength": 15,
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"FaxNb": {
"type": "string",
"description": "Fax Number",
"maxLength": 15,
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"EmailAdr": {
"type": "string",
"description": "Address for electronic mail (e-mail).",
"format": "email",
"maxLength": 2048
},
"Othr": {
"type": "string",
"description": "Contact details in another form.",
"maxLength": 35
}
}
}
}
},
"TaxRmt": {
"type": "object",
"description": "Provides remittance information about a payment made for tax-related purposes.",
"properties": {
"Cdtr": {
"type": "object",
"description": "Party on the credit side of the transaction to which the tax applies.",
"properties": {
"TaxId": {
"type": "string",
"description": "Tax identification number of the creditor.",
"maxLength": 35
},
"RegnId": {
"type": "string",
"description": "Unique identification, as assigned by an organization, to unambiguously identify a party.",
"maxLength": 35
},
"TaxTp": {
"type": "string",
"description": "Type of tax payer.",
"maxLength": 35
}
}
},
"Dbtr": {
"type": "object",
"description": "Identifies the party on the debit side of the transaction to which the tax applies.",
"properties": {
"TaxId": {
"type": "string",
"description": "Tax identification number of the debtor.",
"maxLength": 35
},
"RegnId": {
"type": "string",
"description": "Unique identification, as assigned by an organization, to unambiguously identify a party.",
"maxLength": 35
},
"TaxTp": {
"type": "string",
"description": "Type of tax payer.",
"maxLength": 35
},
"Authstn": {
"type": "object",
"description": "Details of the authorised tax paying party.",
"properties": {
"Titl": {
"type": "string",
"description": "Title or position of debtor or the debtor's authorised representative.",
"maxLength": 35
},
"Nm": {
"type": "string",
"description": "Name of the debtor or the debtor's authorised representative.",
"maxLength": 140
}
}
}
}
},
"UltmtDbtr": {
"type": "object",
"description": "Ultimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.",
"properties": {
"TaxId": {
"type": "string",
"description": "Tax identification number of the debtor.",
"maxLength": 35
},
"RegnId": {
"type": "string",
"description": "Unique identification, as assigned by an organization, to unambiguously identify a party.",
"maxLength": 35
},
"TaxTp": {
"type": "string",
"description": "Type of tax payer.",
"maxLength": 35
},
"Authstn": {
"type": "object",
"description": "Details of the authorised tax paying party.",
"properties": {
"Titl": {
"type": "string",
"description": "Title or position of debtor or the debtor's authorised representative.",
"maxLength": 35
},
"Nm": {
"type": "string",
"description": "Name of the debtor or the debtor's authorised representative.",
"maxLength": 140
}
}
}
}
},
"AdmstnZone": {
"type": "string",
"description": "Territorial part of a country to which the tax payment is related.",
"maxLength": 35
},
"RefNb": {
"type": "string",
"description": "Tax reference information that is specific to a taxing agency.",
"maxLength": 140
},
"Mtd": {
"type": "string",
"description": "Method used to indicate the underlying business or how the tax is paid.",
"maxLength": 35
},
"TtlTaxblBaseAmt": {
"type": "object",
"description": "Total amount of money on which the tax is based.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3,3}$",
"description": "Code allocated to identify a currency."
}
}
},
"TtlTaxAmt": {
"type": "object",
"description": "Total amount of money as result of the calculation of the tax.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3,3}$",
"description": "Code allocated to identify a currency."
}
}
},
"Dt": {
"type": "string",
"description": "Date by which tax is due.",
"format": "date"
},
"SeqNb": {
"type": "integer",
"description": "Sequential number of the tax report."
},
"Rcrd": {
"type": "object",
"description": "Record of tax details.",
"properties": {
"Tp": {
"type": "string",
"description": "High level code to identify the type of tax details.",
"maxLength": 35
},
"Ctgy": {
"type": "string",
"description": "Specifies the tax code as published by the tax authority.",
"maxLength": 35
},
"CtgyDtls": {
"type": "string",
"description": "Provides further details of the category tax code.",
"maxLength": 35
},
"DbtrSts": {
"type": "string",
"description": "Code provided by local authority to identify the status of the party that has drawn up the settlement document.",
"maxLength": 35
},
"CertId": {
"type": "string",
"description": "Identification number of the tax report as assigned by the taxing authority.",
"maxLength": 35
},
"FrmsCd": {
"type": "string",
"description": "Identifies, in a coded form, on which template the tax report is to be provided.",
"maxLength": 35
},
"Prd": {
"type": "object",
"description": "Set of elements used to provide details on the period of time related to the tax payment.",
"properties": {
"Yr": {
"type": "string",
"description": "Year related to the tax payment.",
"format": "date"
},
"Tp": {
"type": "string",
"description": "Identification of the period related to the tax payment. Based on ISO TaxRecordPeriod1Code",
"enum": [
"MM01",
"MM02",
"MM03",
"MM04",
"MM05",
"MM06",
"MM07",
"MM08",
"MM09",
"MM10",
"MM11",
"MM12",
"QTR1",
"QTR2",
"QTR3",
"QTR4",
"HLF1",
"HLF2"
],
"x-enumDescriptions": {
"MM01": "First Month",
"MM02": "Second Month",
"MM03": "Third Month",
"MM04": "Fourth Month",
"MM05": "Fifth Month",
"MM06": "Sixth Month",
"MM07": "Seventh Month",
"MM08": "Eighth Month",
"MM09": "Ninth Month",
"MM10": "Tenth Month",
"MM11": "Eleventh Month",
"MM12": "Twelfth Month",
"QTR1": "First Quarter",
"QTR2": "Second Quarter",
"QTR3": "Third Quarter",
"QTR4": "Fourth Quarter",
"HLF1": "First Half",
"HLF2": "Second Half"
}
},
"FrToDt": {
"type": "object",
"description": "Range of time between a start date and an end date for which the tax report is provided.",
"properties": {
"FrDt": {
"type": "string",
"description": "Start date of the range.",
"format": "date"
},
"ToDt": {
"type": "string",
"description": "End date of the range.",
"format": "date"
}
}
}
}
},
"TaxAmt": {
"type": "object",
"description": "Set of elements used to provide information on the amount of the tax record.",
"properties": {
"Rate": {
"type": "number",
"description": "Rate used to calculate the tax. ",
"minimum": 0,
"maximum": 100,
"multiplpeOf": 1e-10
},
"TtlTaxblBaseAmt": {
"type": "object",
"description": "Amount of money on which the tax is based.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3,3}$",
"description": "Code allocated to identify a currency."
}
}
},
"TtlAmt": {
"type": "object",
"description": "Total amount that is the result of the calculation of the tax for the record.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3,3}$",
"description": "Code allocated to identify a currency."
}
}
},
"Dtls": {
"type": "object",
"description": "Set of elements used to provide details on the tax period and amount.",
"properties": {
"Prd": {
"type": "object",
"description": "Set of elements used to provide details on the period of time related to the tax payment.",
"properties": {
"Yr": {
"type": "string",
"description": "Year related to the tax payment.",
"format": "date"
},
"Tp": {
"type": "string",
"description": "Identification of the period related to the tax payment. Based on ISO TaxRecordPeriod1Code",
"enum": [
"MM01",
"MM02",
"MM03",
"MM04",
"MM05",
"MM06",
"MM07",
"MM08",
"MM09",
"MM10",
"MM11",
"MM12",
"QTR1",
"QTR2",
"QTR3",
"QTR4",
"HLF1",
"HLF2"
],
"x-enumDescriptions": {
"MM01": "First Month",
"MM02": "Second Month",
"MM03": "Third Month",
"MM04": "Fourth Month",
"MM05": "Fifth Month",
"MM06": "Sixth Month",
"MM07": "Seventh Month",
"MM08": "Eighth Month",
"MM09": "Ninth Month",
"MM10": "Tenth Month",
"MM11": "Eleventh Month",
"MM12": "Twelfth Month",
"QTR1": "First Quarter",
"QTR2": "Second Quarter",
"QTR3": "Third Quarter",
"QTR4": "Fourth Quarter",
"HLF1": "First Half",
"HLF2": "Second Half"
}
},
"FrToDt": {
"type": "object",
"description": "Range of time between a start date and an end date for which the tax report is provided.",
"properties": {
"FrDt": {
"type": "string",
"description": "Start date of the range.",
"format": "date"
},
"ToDt": {
"type": "string",
"description": "End date of the range.",
"format": "date"
}
}
}
}
},
"Amt": {
"type": "object",
"description": "Underlying tax amount related to the specified period.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3,3}$",
"description": "Code allocated to identify a currency."
}
}
}
}
},
"AddtlInf": {
"type": "string",
"description": "Further details of the tax record.",
"maxLength": 140
}
}
}
}
}
}
},
"GrnshmtRmt": {
"type": "object",
"description": "Provides remittance information about a payment for garnishment-related purposes.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of garnishment.",
"properties": {
"CdOrPrtry": {
"type": "object",
"description": "Provides the type details of the garnishment.",
"properties": {
"Cd": {
"type": "string",
"description": "Garnishment type in a coded form. Based on ISO ExternalGarnishmentType1Code list",
"enum": [
"GNCS",
"GNDP",
"GTPP"
],
"x-enumDescriptions": {
"GNCS": "Garnishment from a third party payer for Child Support",
"GNDP": "Garnishment from a Direct Payer for Child Support",
"GTPP": "Garnishment from a third party payer to taxing agency"
}
},
"Prtry": {
"type": "string",
"description": "Proprietary identification of the type of garnishment.",
"maxLength": 35
}
}
},
"Issr": {
"type": "string",
"description": "Identification of the issuer of the garnishment type.",
"maxLength": 35
}
}
},
"Grnshee": {
"type": "object",
"description": "Ultimate party that owes an amount of money to the (ultimate) creditor, in this case, to the garnisher.",
"properties": {
"Nm": {
"description": "Name by which the party is known and which is usually used to identify the party.<br/><ul><li>Must include one (1) name string.<li>Allowable characters: Alphanumeric and space.<li>Names with multiple words must be separated by a space.<li>For example, specify \"Widgets Org\", as `Widgets Org`.<li>Provide a truncated name if longer than 140 characters.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 140
},
"StrdNm": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>Allowable characters: Alphanumeric and space.<li>If the name has multiple words, separate them by a space.<li>Provide a truncated name if longer than allowable characters.",
"required": [
"FirstNm",
"LastNm"
],
"properties": {
"FirstNm": {
"description": "First name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the first name has two or more words, separate them with a space.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.<li>Provide a truncated name if longer than allowable characters.</ul><b>Example</b></br><ul><li>If the party's full name is 'Norma-Jean Baker' where 'Norma-Jean' is the first name, the `StrdNm.FirstNm` value must be 'Norma Jean'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"MidNm": {
"description": "Middle name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm": {
"description": "Last name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the last name has two or more words, separate them with a space.<li>Provide a truncated name if longer than allowable characters.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.</ul><b>Example</b></br><ul><li>If the party's full name is 'Enrique Miguel Iglesias Preysler,' where 'Iglesias Preysler' is the last name, the `StrdNm.LastNm` value must be 'Iglesias Preysler'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm2": {
"description": "Secondary last name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"NtrlNm": {
"description": "Name in local character set or language.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Title": {
"description": "Title by which the party is known and which is usually used to identify the party.",
"type": "string",
"minLength": 1,
"maxLength": 20
}
}
},
"CtryOfRes": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1 list](https://www.iso.org/obp/ui/#search)."
},
"PstlAdr": {
"type": "object",
"description": "Address for the party or organization.",
"properties": {
"AdrTp": {
"type": "string",
"description": "Specifies the type of address based on the [ISO20022 AddressType1Code](https://www.iso20022.org/standardsrepository/type/AddressType1Code) list",
"minItems": 1,
"maxItems": 1,
"enum": [
"ADDR",
"PBOX",
"HOME",
"BIZZ",
"MLTO",
"DLVY"
],
"x-enumDescriptions": {
"ADDR": "Postal",
"PBOX": "PO Box",
"HOME": "Residential",
"BIZZ": "Business",
"MLTO": "Mail To",
"DLVY": "Delivery To"
}
},
"AdrLine": {
"description": "Information that locates and identifies the address for the party.",
"type": "array",
"maxLength": 70
},
"Dept": {
"description": "Information that locates and identifies the department for the party.",
"type": "string",
"maxLength": 70
},
"SubDept": {
"description": "Information that locates and identifies the sub department for the party.",
"type": "string",
"maxLength": 70
},
"StrtNm": {
"description": "Information that locates and identifies the street name for the party, as defined by postal services.",
"type": "string",
"maxLength": 70
},
"BldgNb": {
"description": "Information that locates and identifies the building number for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"PstCd": {
"description": "Information that locates and identifies postal code for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"TwnNm": {
"description": "Information that locates and identifies the city / town for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"CtrySubDvsn": {
"description": "Information that locates and identifies the state / county for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"Ctry": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country for the party, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list."
}
}
},
"Id": {
"type": "object",
"description": "Unique and unambiguous way to identify an individual or organization.",
"properties": {
"OrgId": {
"type": "object",
"description": "Unique and unambiguous way to identify an individual or organization.",
"properties": {
"AnyBIC": {
"type": "string",
"pattern": "^([a-zA-Z0-9_-]){8,11}$",
"description": "The Business identifier code (BIC) allocated to a receiving institution by the [ISO 9362 Registration Authority](https://www.iso.org/standard/84108.html).<br/><br/><b>Example</b>: `BANKGB22`"
},
"DtAndPlcofIncorprtn": {
"type": "object",
"description": "<b>[Soft field](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the organization's date and place of incorporation.",
"properties": {
"DtofIncorprtn": {
"type": "string",
"description": "The date of incorporation for the organization.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"CtryofIncorprtn": {
"type": "string",
"description": "Information that locates and identifies the country, as defined by postal services where the organization was incorporated. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.",
"pattern": "^[A-Z]{2}"
}
}
},
"Othr": {
"type": "array",
"description": "An array of objects, each containing unique identification of an organization, as assigned by an institution, using an identification scheme.",
"items": {
"type": "object",
"properties": {
"Id": {
"description": "Identification assigned by an institution.",
"type": "string",
"maxLength": 35
},
"Issr": {
"description": "Entity that assigns the identification.",
"type": "string",
"maxLength": 35
},
"DtOfIsse": {
"description": "The date of issuance of the supporting documentation.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"DtOfXpry": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>The date of expiration of the supporting documentation.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"SchmeNm": {
"type": "object",
"description": "Name of the organization identification scheme.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ExternalorganizationIdentification1Code List",
"enum": [
"BANK",
"CBID",
"CHID",
"CINC",
"COID",
"CUST",
"DUNS",
"EMPL",
"GS1G",
"SREN",
"SRET",
"TXID",
"USCC"
],
"x-enumDescriptions": {
"BANK": "Bank Party Identification",
"CBID": "Central Bank Identification Number",
"CHID": "Clearing Identification Number",
"CINC": "Certificate Of Incorporation Number",
"COID": "Country Identification Code",
"CUST": "Customer Number",
"DUNS": "Data Universal Numbering System",
"EMPL": "Employer Identification Number",
"GS1G": "GS1GLN Identifier",
"SREN": "SIREN",
"SRET": "SIRET",
"TXID": "Tax Identification Number",
"USCC": "Unified Social Credit Code"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
}
}
}
},
"RelShipToDbtr": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the relationship between the Sender and Receiver.",
"enum": [
"BRAN",
"CUST",
"FRAN",
"HOLD",
"PART",
"SUBS",
"SUPP"
],
"x-enumDescriptions": {
"BRAN": "Branch or representative office",
"CUST": "Customer",
"FRAN": "Franchisee or franchisor",
"HOLD": "Holding company",
"PART": "Business partner",
"SUBS": "Subsidiary company",
"SUPP": "Supplier"
}
},
"RelShipToCdtr": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the relationship between the Sender and Receiver.",
"enum": [
"BRAN",
"CUST",
"FRAN",
"HOLD",
"PART",
"SUBS",
"SUPP"
],
"x-enumDescriptions": {
"BRAN": "Branch or representative office",
"CUST": "Customer",
"FRAN": "Franchisee or franchisor",
"HOLD": "Holding company",
"PART": "Business partner",
"SUBS": "Subsidiary company",
"SUPP": "Supplier"
}
},
"Rprtv": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the name of the organization's representative.",
"properties": {
"StrdNm": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Allows the name of the organization's representative to be held in a structured format.",
"required": [
"FirstNm",
"LastNm"
],
"properties": {
"FirstNm": {
"description": "First name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the first name has two or more words, separate them with a space.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.<li>Provide a truncated name if longer than allowable characters.</ul><b>Example</b></br><ul><li>If the party's full name is 'Norma-Jean Baker' where 'Norma-Jean' is the first name, the `StrdNm.FirstNm` value must be 'Norma Jean'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"MidNm": {
"description": "Middle name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm": {
"description": "Last name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the last name has two or more words, separate them with a space.<li>Provide a truncated name if longer than allowable characters.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.</ul><b>Example</b></br><ul><li>If the party's full name is 'Enrique Miguel Iglesias Preysler,' where 'Iglesias Preysler' is the last name, the `StrdNm.LastNm` value must be 'Iglesias Preysler'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm2": {
"description": "Secondary last name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"NtrlNm": {
"description": "Name in local character set or language.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Title": {
"description": "Title by which the party is known and which is usually used to identify the party.",
"type": "string",
"minLength": 1,
"maxLength": 20
}
}
}
}
}
}
},
"PrvtId": {
"type": "object",
"description": "Unique and unambiguous identification of a person, e.g., passport.",
"properties": {
"DtAndPlcOfBirth": {
"type": "object",
"description": "Date and place of birth of a person.",
"properties": {
"BirthDt": {
"description": "Information that identifies the date of Birth for the party.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"PrvcOfBirth": {
"description": "Information that locates and identifies the Province of birth for the party.",
"type": "string",
"maxLength": 35
},
"CityOfBirth": {
"description": "Information that locates and identifies the city of birth for the party.",
"type": "string",
"maxLength": 35
},
"CtryOfBirth": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country of birth for the party, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list."
}
}
},
"Othr": {
"type": "array",
"description": "An array of objects, each containing the unique identification of a party, as assigned by an institution, using an identification scheme.",
"items": {
"type": "object",
"properties": {
"Id": {
"description": "Value to be used to identify the party",
"type": "string",
"maxLength": 35
},
"Issr": {
"description": "Information for the Entity that assigns the identification.",
"type": "string",
"maxLength": 35
},
"SchmeNm": {
"type": "object",
"description": "Name of the identification scheme used to identify an individual.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ISO20022 ExternalPersonIdentification1Code List ",
"enum": [
"ARNU",
"CCPT",
"CUST",
"DRLC",
"EMPL",
"NIDN",
"SOS",
"TELE",
"TXID"
],
"x-enumDescriptions": {
"ARNU": "Alien Registration Number",
"CCPT": "Passport Number",
"CUST": "Customer Identification Number",
"DRLC": "Drivers License Number",
"EMPL": "Employee Identification Number",
"NIDN": "National Identity Number",
"SOS": "Social Security Number",
"TELE": "Telephone Number",
"TXID": "Tax Identification Number"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"DtOfIss": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Issue date of the ID.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"DtOfXpry": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Expiry date of the ID.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"MrzNb": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Machine Readable Zone for Passport. This field only applies if the ID is a passport.",
"type": "string",
"maxLength": 88,
"pattern": "^[A-Z<]{1}[A-Z0-9<]{1}[A-Z<]{3}[0-9<]{6}[A0-9<]{1}[0-9<]{1}[A0-9<]{7}[A-Z<]{1}[0-9<]{1}[0-9<]{3}[A0-9<]{1}[0-9<]{1}[A0-9<]{7}[0-9<]{14}$"
}
}
}
},
"Gndr": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Information that captures the Gender of a party.",
"type": "string",
"maxLength": 6,
"enum": [
"Male",
"Female",
"Other"
],
"x-enumDescriptions": {
"Male": "Male",
"Female": "Female",
"Other": "Other"
}
},
"Prfssn": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Information that captures the occupation of a party.",
"type": "string",
"maxLength": 35
},
"RelShipToDbtr": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Relationship of the receiving party to the sending party.<br/><strong>Note</strong>: This information is required within the creditor object `cdtr` for payout in the Philippines.",
"type": "string",
"enum": [
"CHIL",
"CUST",
"EMPL",
"EXSP",
"FREN",
"OTHR",
"PARE",
"PART",
"RELA",
"SELF",
"SIBL",
"SPOU",
"VEND"
],
"x-enumDescriptions": {
"CHIL": "Child",
"CUST": "Customer",
"EMPL": "Employee",
"EXSP": "Ex-spouse",
"FREN": "Friend",
"OTHR": "Other",
"PARE": "Parent",
"PART": "Business partner",
"RELA": "Relation",
"SELF": "Self",
"SIBL": "Sibling",
"SPOU": "Covering Spouse/Partner",
"VEND": "Vendor"
}
},
"RelShipToCdtr": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Relationship of the receiving party to the sending party.<br/><strong>Note</strong>: This information is required within the creditor object `cdtr` for payout in the Philippines.",
"type": "string",
"enum": [
"CHIL",
"CUST",
"EMPL",
"EXSP",
"FREN",
"OTHR",
"PARE",
"PART",
"RELA",
"SELF",
"SIBL",
"SPOU",
"VEND"
],
"x-enumDescriptions": {
"CHIL": "Child",
"CUST": "Customer",
"EMPL": "Employee",
"EXSP": "Ex-spouse",
"FREN": "Friend",
"OTHR": "Other",
"PARE": "Parent",
"PART": "Business partner",
"RELA": "Relation",
"SELF": "Self",
"SIBL": "Sibling",
"SPOU": "Covering Spouse/Partner",
"VEND": "Vendor"
}
},
"Ntlty": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>ISO country code of nationality of the party.",
"maxLength": 3
},
"Residence": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Country of residence of the party. Use ISO Country Code for value.",
"maxLength": 3
},
"Ctznsh": {
"type": "object",
"properties": {
"Ntlty": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Nationality of the party. Use ISO Country Code for values.",
"maxLength": 3
},
"MnrId": {
"description": "Indicates whether the party is a minor.",
"type": "string",
"enum": [
"YES",
"NO"
],
"x-enumDescriptions": {
"YES": "Party is a minor.",
"NO": "Party is not a minor."
}
},
"StartDt": {
"description": "Start date of citizenship for the party.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"EndDt": {
"description": "End date of citizenship for the party.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
}
}
}
}
}
}
},
"CtctDtls": {
"type": "object",
"description": "Contact Details for the individual or organization",
"properties": {
"NmPrfx": {
"type": "string",
"description": "List based on ISO 20022 NamePrefix1Code List",
"enum": [
"DOCT",
"MIST",
"MISS",
"MADM"
],
"x-enumDescriptions": {
"DOCT": "Doctor",
"MIST": "Mister",
"MISS": "Miss",
"MADM": "Madam"
}
},
"Nm": {
"type": "string",
"description": "Name by which a party is known and which is usually used to identify that party.",
"maxLength": 140
},
"PhneNb": {
"type": "string",
"description": "Phone Number",
"maxLength": 15,
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"MobNb": {
"type": "string",
"description": "Mobile Phone Number",
"maxLength": 15,
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"FaxNb": {
"type": "string",
"description": "Fax Number",
"maxLength": 15,
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"EmailAdr": {
"type": "string",
"description": "Address for electronic mail (e-mail).",
"format": "email",
"maxLength": 2048
},
"Othr": {
"type": "string",
"description": "Contact details in another form.",
"maxLength": 35
}
}
}
}
},
"GrnshmyAdmstr": {
"type": "object",
"description": "Party on the credit side of the transaction who administers the garnishment on behalf of the ultimate beneficiary.",
"properties": {
"Nm": {
"description": "Name by which the party is known and which is usually used to identify the party.<br/><ul><li>Must include one (1) name string.<li>Allowable characters: Alphanumeric and space.<li>Names with multiple words must be separated by a space.<li>For example, specify \"Widgets Org\", as `Widgets Org`.<li>Provide a truncated name if longer than 140 characters.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 140
},
"StrdNm": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>Allowable characters: Alphanumeric and space.<li>If the name has multiple words, separate them by a space.<li>Provide a truncated name if longer than allowable characters.",
"required": [
"FirstNm",
"LastNm"
],
"properties": {
"FirstNm": {
"description": "First name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the first name has two or more words, separate them with a space.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.<li>Provide a truncated name if longer than allowable characters.</ul><b>Example</b></br><ul><li>If the party's full name is 'Norma-Jean Baker' where 'Norma-Jean' is the first name, the `StrdNm.FirstNm` value must be 'Norma Jean'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"MidNm": {
"description": "Middle name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm": {
"description": "Last name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the last name has two or more words, separate them with a space.<li>Provide a truncated name if longer than allowable characters.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.</ul><b>Example</b></br><ul><li>If the party's full name is 'Enrique Miguel Iglesias Preysler,' where 'Iglesias Preysler' is the last name, the `StrdNm.LastNm` value must be 'Iglesias Preysler'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm2": {
"description": "Secondary last name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"NtrlNm": {
"description": "Name in local character set or language.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Title": {
"description": "Title by which the party is known and which is usually used to identify the party.",
"type": "string",
"minLength": 1,
"maxLength": 20
}
}
},
"CtryOfRes": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1 list](https://www.iso.org/obp/ui/#search)."
},
"PstlAdr": {
"type": "object",
"description": "Address for the party or organization.",
"properties": {
"AdrTp": {
"type": "string",
"description": "Specifies the type of address based on the [ISO20022 AddressType1Code](https://www.iso20022.org/standardsrepository/type/AddressType1Code) list",
"minItems": 1,
"maxItems": 1,
"enum": [
"ADDR",
"PBOX",
"HOME",
"BIZZ",
"MLTO",
"DLVY"
],
"x-enumDescriptions": {
"ADDR": "Postal",
"PBOX": "PO Box",
"HOME": "Residential",
"BIZZ": "Business",
"MLTO": "Mail To",
"DLVY": "Delivery To"
}
},
"AdrLine": {
"description": "Information that locates and identifies the address for the party.",
"type": "array",
"maxLength": 70
},
"Dept": {
"description": "Information that locates and identifies the department for the party.",
"type": "string",
"maxLength": 70
},
"SubDept": {
"description": "Information that locates and identifies the sub department for the party.",
"type": "string",
"maxLength": 70
},
"StrtNm": {
"description": "Information that locates and identifies the street name for the party, as defined by postal services.",
"type": "string",
"maxLength": 70
},
"BldgNb": {
"description": "Information that locates and identifies the building number for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"PstCd": {
"description": "Information that locates and identifies postal code for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"TwnNm": {
"description": "Information that locates and identifies the city / town for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"CtrySubDvsn": {
"description": "Information that locates and identifies the state / county for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"Ctry": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country for the party, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list."
}
}
},
"Id": {
"type": "object",
"description": "Unique and unambiguous way to identify an individual or organization.",
"properties": {
"OrgId": {
"type": "object",
"description": "Unique and unambiguous way to identify an individual or organization.",
"properties": {
"AnyBIC": {
"type": "string",
"pattern": "^([a-zA-Z0-9_-]){8,11}$",
"description": "The Business identifier code (BIC) allocated to a receiving institution by the [ISO 9362 Registration Authority](https://www.iso.org/standard/84108.html).<br/><br/><b>Example</b>: `BANKGB22`"
},
"DtAndPlcofIncorprtn": {
"type": "object",
"description": "<b>[Soft field](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the organization's date and place of incorporation.",
"properties": {
"DtofIncorprtn": {
"type": "string",
"description": "The date of incorporation for the organization.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"CtryofIncorprtn": {
"type": "string",
"description": "Information that locates and identifies the country, as defined by postal services where the organization was incorporated. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.",
"pattern": "^[A-Z]{2}"
}
}
},
"Othr": {
"type": "array",
"description": "An array of objects, each containing unique identification of an organization, as assigned by an institution, using an identification scheme.",
"items": {
"type": "object",
"properties": {
"Id": {
"description": "Identification assigned by an institution.",
"type": "string",
"maxLength": 35
},
"Issr": {
"description": "Entity that assigns the identification.",
"type": "string",
"maxLength": 35
},
"DtOfIsse": {
"description": "The date of issuance of the supporting documentation.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"DtOfXpry": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>The date of expiration of the supporting documentation.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"SchmeNm": {
"type": "object",
"description": "Name of the organization identification scheme.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ExternalorganizationIdentification1Code List",
"enum": [
"BANK",
"CBID",
"CHID",
"CINC",
"COID",
"CUST",
"DUNS",
"EMPL",
"GS1G",
"SREN",
"SRET",
"TXID",
"USCC"
],
"x-enumDescriptions": {
"BANK": "Bank Party Identification",
"CBID": "Central Bank Identification Number",
"CHID": "Clearing Identification Number",
"CINC": "Certificate Of Incorporation Number",
"COID": "Country Identification Code",
"CUST": "Customer Number",
"DUNS": "Data Universal Numbering System",
"EMPL": "Employer Identification Number",
"GS1G": "GS1GLN Identifier",
"SREN": "SIREN",
"SRET": "SIRET",
"TXID": "Tax Identification Number",
"USCC": "Unified Social Credit Code"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
}
}
}
},
"RelShipToDbtr": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the relationship between the Sender and Receiver.",
"enum": [
"BRAN",
"CUST",
"FRAN",
"HOLD",
"PART",
"SUBS",
"SUPP"
],
"x-enumDescriptions": {
"BRAN": "Branch or representative office",
"CUST": "Customer",
"FRAN": "Franchisee or franchisor",
"HOLD": "Holding company",
"PART": "Business partner",
"SUBS": "Subsidiary company",
"SUPP": "Supplier"
}
},
"RelShipToCdtr": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the relationship between the Sender and Receiver.",
"enum": [
"BRAN",
"CUST",
"FRAN",
"HOLD",
"PART",
"SUBS",
"SUPP"
],
"x-enumDescriptions": {
"BRAN": "Branch or representative office",
"CUST": "Customer",
"FRAN": "Franchisee or franchisor",
"HOLD": "Holding company",
"PART": "Business partner",
"SUBS": "Subsidiary company",
"SUPP": "Supplier"
}
},
"Rprtv": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Indicates the name of the organization's representative.",
"properties": {
"StrdNm": {
"type": "object",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Allows the name of the organization's representative to be held in a structured format.",
"required": [
"FirstNm",
"LastNm"
],
"properties": {
"FirstNm": {
"description": "First name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the first name has two or more words, separate them with a space.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.<li>Provide a truncated name if longer than allowable characters.</ul><b>Example</b></br><ul><li>If the party's full name is 'Norma-Jean Baker' where 'Norma-Jean' is the first name, the `StrdNm.FirstNm` value must be 'Norma Jean'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"MidNm": {
"description": "Middle name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm": {
"description": "Last name by which the party is known and which is usually used to identify the party.<br/><b>Requirements</b><br/><ul><li>Must include one (1) name string.<li>If the last name has two or more words, separate them with a space.<li>Provide a truncated name if longer than allowable characters.<li>Do not use this field to specify the individual's middle name. Use `StrdNm.MidNm` instead.</ul><b>Example</b></br><ul><li>If the party's full name is 'Enrique Miguel Iglesias Preysler,' where 'Iglesias Preysler' is the last name, the `StrdNm.LastNm` value must be 'Iglesias Preysler'.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"LastNm2": {
"description": "Secondary last name by which the party is known and which is usually used to identify the party.",
"type": "string",
"pattern": "^[a-zA-Z0-9 \\t]+$",
"minLength": 1,
"maxLength": 30
},
"NtrlNm": {
"description": "Name in local character set or language.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Title": {
"description": "Title by which the party is known and which is usually used to identify the party.",
"type": "string",
"minLength": 1,
"maxLength": 20
}
}
}
}
}
}
},
"PrvtId": {
"type": "object",
"description": "Unique and unambiguous identification of a person, e.g., passport.",
"properties": {
"DtAndPlcOfBirth": {
"type": "object",
"description": "Date and place of birth of a person.",
"properties": {
"BirthDt": {
"description": "Information that identifies the date of Birth for the party.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"PrvcOfBirth": {
"description": "Information that locates and identifies the Province of birth for the party.",
"type": "string",
"maxLength": 35
},
"CityOfBirth": {
"description": "Information that locates and identifies the city of birth for the party.",
"type": "string",
"maxLength": 35
},
"CtryOfBirth": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country of birth for the party, as defined by postal services. Use Alpha-2 Code as defined in the [ISO CountryCode ISO 3166-1](https://www.iso.org/obp/ui/#search) list."
}
}
},
"Othr": {
"type": "array",
"description": "An array of objects, each containing the unique identification of a party, as assigned by an institution, using an identification scheme.",
"items": {
"type": "object",
"properties": {
"Id": {
"description": "Value to be used to identify the party",
"type": "string",
"maxLength": 35
},
"Issr": {
"description": "Information for the Entity that assigns the identification.",
"type": "string",
"maxLength": 35
},
"SchmeNm": {
"type": "object",
"description": "Name of the identification scheme used to identify an individual.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ISO20022 ExternalPersonIdentification1Code List ",
"enum": [
"ARNU",
"CCPT",
"CUST",
"DRLC",
"EMPL",
"NIDN",
"SOS",
"TELE",
"TXID"
],
"x-enumDescriptions": {
"ARNU": "Alien Registration Number",
"CCPT": "Passport Number",
"CUST": "Customer Identification Number",
"DRLC": "Drivers License Number",
"EMPL": "Employee Identification Number",
"NIDN": "National Identity Number",
"SOS": "Social Security Number",
"TELE": "Telephone Number",
"TXID": "Tax Identification Number"
}
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"DtOfIss": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Issue date of the ID.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"DtOfXpry": {
"type": "string",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Expiry date of the ID.",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"MrzNb": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Machine Readable Zone for Passport. This field only applies if the ID is a passport.",
"type": "string",
"maxLength": 88,
"pattern": "^[A-Z<]{1}[A-Z0-9<]{1}[A-Z<]{3}[0-9<]{6}[A0-9<]{1}[0-9<]{1}[A0-9<]{7}[A-Z<]{1}[0-9<]{1}[0-9<]{3}[A0-9<]{1}[0-9<]{1}[A0-9<]{7}[0-9<]{14}$"
}
}
}
},
"Gndr": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Information that captures the Gender of a party.",
"type": "string",
"maxLength": 6,
"enum": [
"Male",
"Female",
"Other"
],
"x-enumDescriptions": {
"Male": "Male",
"Female": "Female",
"Other": "Other"
}
},
"Prfssn": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Information that captures the occupation of a party.",
"type": "string",
"maxLength": 35
},
"RelShipToDbtr": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Relationship of the receiving party to the sending party.<br/><strong>Note</strong>: This information is required within the creditor object `cdtr` for payout in the Philippines.",
"type": "string",
"enum": [
"CHIL",
"CUST",
"EMPL",
"EXSP",
"FREN",
"OTHR",
"PARE",
"PART",
"RELA",
"SELF",
"SIBL",
"SPOU",
"VEND"
],
"x-enumDescriptions": {
"CHIL": "Child",
"CUST": "Customer",
"EMPL": "Employee",
"EXSP": "Ex-spouse",
"FREN": "Friend",
"OTHR": "Other",
"PARE": "Parent",
"PART": "Business partner",
"RELA": "Relation",
"SELF": "Self",
"SIBL": "Sibling",
"SPOU": "Covering Spouse/Partner",
"VEND": "Vendor"
}
},
"RelShipToCdtr": {
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Relationship of the receiving party to the sending party.<br/><strong>Note</strong>: This information is required within the creditor object `cdtr` for payout in the Philippines.",
"type": "string",
"enum": [
"CHIL",
"CUST",
"EMPL",
"EXSP",
"FREN",
"OTHR",
"PARE",
"PART",
"RELA",
"SELF",
"SIBL",
"SPOU",
"VEND"
],
"x-enumDescriptions": {
"CHIL": "Child",
"CUST": "Customer",
"EMPL": "Employee",
"EXSP": "Ex-spouse",
"FREN": "Friend",
"OTHR": "Other",
"PARE": "Parent",
"PART": "Business partner",
"RELA": "Relation",
"SELF": "Self",
"SIBL": "Sibling",
"SPOU": "Covering Spouse/Partner",
"VEND": "Vendor"
}
},
"Ntlty": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>ISO country code of nationality of the party.",
"maxLength": 3
},
"Residence": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "<b>[[Soft field]](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields)</b><br/>Country of residence of the party. Use ISO Country Code for value.",
"maxLength": 3
},
"Ctznsh": {
"type": "object",
"properties": {
"Ntlty": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Nationality of the party. Use ISO Country Code for values.",
"maxLength": 3
},
"MnrId": {
"description": "Indicates whether the party is a minor.",
"type": "string",
"enum": [
"YES",
"NO"
],
"x-enumDescriptions": {
"YES": "Party is a minor.",
"NO": "Party is not a minor."
}
},
"StartDt": {
"description": "Start date of citizenship for the party.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
},
"EndDt": {
"description": "End date of citizenship for the party.",
"type": "string",
"format": "date",
"pattern": "^(18|19|20|21)\\d\\d([-])(0[1-9]|1[012])\\2(0[1-9]|[12][0-9]|3[01])$"
}
}
}
}
}
}
},
"CtctDtls": {
"type": "object",
"description": "Contact Details for the individual or organization",
"properties": {
"NmPrfx": {
"type": "string",
"description": "List based on ISO 20022 NamePrefix1Code List",
"enum": [
"DOCT",
"MIST",
"MISS",
"MADM"
],
"x-enumDescriptions": {
"DOCT": "Doctor",
"MIST": "Mister",
"MISS": "Miss",
"MADM": "Madam"
}
},
"Nm": {
"type": "string",
"description": "Name by which a party is known and which is usually used to identify that party.",
"maxLength": 140
},
"PhneNb": {
"type": "string",
"description": "Phone Number",
"maxLength": 15,
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"MobNb": {
"type": "string",
"description": "Mobile Phone Number",
"maxLength": 15,
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"FaxNb": {
"type": "string",
"description": "Fax Number",
"maxLength": 15,
"pattern": "^\\+?[1-9]\\d{1,14}$"
},
"EmailAdr": {
"type": "string",
"description": "Address for electronic mail (e-mail).",
"format": "email",
"maxLength": 2048
},
"Othr": {
"type": "string",
"description": "Contact details in another form.",
"maxLength": 35
}
}
}
}
},
"RefNb": {
"type": "string",
"description": "Reference information that is specific to the agency receiving the garnishment.",
"maxLength": 140
},
"Dt": {
"type": "string",
"description": "Date of payment which garnishment was taken from.",
"format": "date"
},
"RmtdAmt": {
"type": "object",
"description": "Amount of money remitted for the referred document.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3,3}$",
"description": "Code allocated to identify a currency."
}
}
},
"FmlyMdcllnsrncInd": {
"type": "boolean",
"description": "Indicates if the person to whom the garnishment applies (that is, the ultimate debtor) has family medical insurance coverage available."
},
"MplyeeTermntnInd": {
"type": "boolean",
"description": "Indicates if the employment of the person to whom the garnishment applies (that is, the ultimate debtor) has been terminated."
}
}
},
"AddtlRmtInf": {
"type": "array",
"description": "Additional information, in the form of an array of strings, to complement the structured remittance information. Maximum of 4 lines to ensure consistency with the ISO20022 specification."
}
}
}
}
},
"original_message_pacs008": {
"type": "string",
"description": "Provides the ability to include the original PACS.008 message"
},
"original_message_mt103": {
"type": "string",
"description": "Provides the ability to include the original MT103 message"
}
},
"required": [
"end_to_end_id",
"Dbtr",
"DbtrAcct",
"CdtrAgt",
"Cdtr",
"CdtrAcct",
"RmtInf"
]
}Previous version
Previous versions of the RippleNet Payment Object are shown here for legacy implementations.
Legacy JSON schema
Schemas shown here are for reference purposes. All new implementations should use the current version.
Click to expand previous version v1.1.5
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "file://po11#",
"title": "RippleNet Payment Object - Supporting Information Schema",
"description": "RippleNet Payment Object - Supporting Information Schema, Version 1.1.5",
"definitions": {
"externalclearingsystem": {
"type": "string",
"description": "List based on ISO20022 ExternalClearingSystemIdentification1Code List",
"enum": [
"ATBLZ",
"AUBSB",
"BEFTN",
"CACPA",
"CHBCC",
"CHSIC",
"CNAPS",
"DEBLZ",
"ESNCC",
"GBDSC",
"GRBIC",
"HKNCC",
"IENCC",
"INFSC",
"ITNCC",
"JPZGN",
"NGBCS",
"NZNCC",
"PLKNR",
"PTNCC",
"RUCBC",
"SESBA",
"SGIBG",
"SLCFT",
"THCBC",
"TWNCC",
"USABA",
"USPID",
"ZANCC"
]
},
"externalcashaccount": {
"type": "string",
"description": "List based on ISO20022 ExternalCashAccountType1Code List",
"enum": [
"CACC",
"CARD",
"CASH",
"CHAR",
"CISH",
"COMM",
"CPAC",
"LLSV",
"LOAN",
"MGLD",
"MOMA",
"NREX",
"ODFT",
"ONDP",
"OTHR",
"SACC",
"SLRY",
"SVGS",
"TAXE",
"TRAN",
"TRAS"
]
},
"levelofpurpose": {
"type": "string",
"description": "List based on ISO20022 ExternalCategoryPurpose1Code List",
"enum": [
"BONU",
"CASH",
"CBLK",
"CCRD",
"CORT",
"DCRD",
"DIVI",
"DVPM",
"EPAY",
"FCIN",
"FCOL",
"GOVT",
"GP2P",
"HEDG",
"ICCP",
"IDCP",
"INTC",
"INTE",
"LBOX",
"LOAN",
"MP2B",
"MP2P",
"OTHR",
"PENS",
"RPRE",
"RRCT",
"RVPM",
"SALA",
"SECU",
"SSBE",
"SUPP",
"TAXS",
"TRAD",
"TREA",
"VATX",
"WHLD"
]
},
"SourceOfCash": {
"type": "string",
"description": "Source where funds have come from for the payment.",
"enum": [
"ALMY",
"CASH",
"COMP",
"EMIN",
"GIFT",
"INHE",
"INLQ",
"PACA",
"REDM",
"REPY",
"REST",
"RETA",
"SALE",
"SEAQ",
"SELF",
"SVGS",
"WINS"
]
},
"external_account_id": {
"type": "string",
"description": "Identifier of an account, as assigned by the account servicer, list based on a combination of ExternalAccountIdentification1Code and AccountIdentification30Choice ISO 20022 Lists ",
"enum": [
"AIIN",
"BBAN",
"CARD",
"CASH",
"CASHD2D",
"CUID",
"UPIC",
"EMail",
"MSISDN",
"Dmst",
"Other"
]
},
"bic": {
"type": "string",
"pattern": "^([a-zA-Z0-9_-]){8,11}$",
"description": "Code allocated to a receiving institution by the ISO 9362 Registration Authority as described in ISO 9362 'Banking - Banking telecommunication messages - Business identifier code (BIC)'"
},
"country": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list."
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3,3}$",
"description": "Code allocated to identify a currency."
},
"phone_number": {
"type": "string",
"description": "Code allocated to identify a contact phone number."
},
"iban": {
"type": "string",
"pattern": "^([a-zA-Z0-9_-]){15,35}$",
"description": "IBAN for the account."
},
"fullname": {
"description": "Name by which the party is known and which is usually used to identify the party.",
"type": "string",
"maxLength": 140
},
"name": {
"type": "object",
"properties": {
"FirstNm": {
"description": "First name by which the party is known and which is usually used to identify the party.",
"type": "string",
"maxLength": 30
},
"MidNm": {
"description": "Middle name by which the party is known and which is usually used to identify the party.",
"type": "string",
"maxLength": 30
},
"LastNm": {
"description": "Last name by which the party is known and which is usually used to identify the party.",
"type": "string",
"maxLength": 30
},
"LastNm2": {
"description": "Secondary last name by which the party is known and which is usually used to identify the party.",
"type": "string",
"maxLength": 30
},
"NtrlNm": {
"description": "Name in local character set or language.",
"type": "string",
"maxLength": 140
},
"Title": {
"description": "Title by which the party is known and which is usually used to identify the party.",
"type": "string",
"maxLength": 20
}
}
},
"address": {
"type": "object",
"properties": {
"AdrTp": {
"type": "string",
"description": "List based on ISO20022 AddressType1Code List",
"enum": [
"ADDR",
"PBOX",
"HOME",
"BIZZ",
"MLTO",
"DLVY"
]
},
"AdrLine": {
"description": "Information that locates and identifies the address for the party.",
"type": "array",
"maxLength": 70
},
"Dept": {
"description": "Information that locates and identifies the department for the party.",
"type": "string",
"maxLength": 70
},
"SubDept": {
"description": "Information that locates and identifies the sub department for the party.",
"type": "string",
"maxLength": 70
},
"StrtNm": {
"description": "Information that locates and identifies the street name for the party, as defined by postal services.",
"type": "string",
"maxLength": 70
},
"BldgNb": {
"description": "Information that locates and identifies the building number for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"PstCd": {
"description": "Information that locates and identifies postal code for the party, as defined by postal services.",
"type": "string",
"maxLength": 16
},
"TwnNm": {
"description": "Information that locates and identifies the city / town for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"CtrySubDvsn": {
"description": "Information that locates and identifies the state / county for the party, as defined by postal services.",
"type": "string",
"maxLength": 35
},
"Ctry": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country for the party, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.",
"$ref": "#/definitions/country"
}
}
},
"id_section": {
"type": "object",
"description": "Unique and unambiguous way to identify an individual or organization.",
"properties": {
"OrgId": {
"type": "object",
"description": "Unique and unambiguous way to identify an individual or organization.",
"properties": {
"AnyBIC": {
"description": "Code allocated to a receiving institution by the ISO 9362 Registration Authority as described in ISO 9362 'Banking - Banking telecommunication messages - Business identiFer code (BIC)'",
"$ref": "#/definitions/bic"
},
"DtAndPlcofIncorprtn": {
"type": "object",
"description": "Indicates the organization's date and place of incorporation.",
"properties": {
"DtofIncorprtn": {
"type": "string",
"description": "The date of incorporation for the organization.",
"format": "date-time"
},
"CtryofIncorprtn": {
"type": "string",
"description": "Information that locates and identifies the country, as defined by postal services where the organization was incorporated. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.",
"pattern": "^[A-Z]{2}$"
}
}
},
"Othr": {
"type": "array",
"description": "An array of objects, each containing unique identification of an organization, as assigned by an institution, using an identification scheme.",
"properties": {
"Id": {
"description": "Identification assigned by an institution.",
"type": "string",
"maxLength": 35
},
"Issr": {
"description": "Entity that assigns the identification.",
"type": "string",
"maxLength": 35
},
"DtOfIss": {
"description": "Information that identifies the date of incorporation in ISO Date format (YYYY-MM-DD) for a sending organization or institution.",
"type": "string",
"maxLength": 10
},
"DtOfIsse": {
"description": "The date of issuance of the supporting documentation.",
"type": "string",
"format": "date-time"
},
"DtOfXpry": {
"description": "The date of expiration of the supporting documentation.",
"type": "string",
"format": "date-time"
},
"SchmeNm": {
"type": "object",
"description": "Name of the organization identification scheme.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ExternalorganizationIdentification1Code List",
"enum": [
"BANK",
"CBID",
"CHID",
"CINC",
"COID",
"CUST",
"DUNS",
"EMPL",
"GS1G",
"SREN",
"SRET",
"TXID",
"USCC"
]
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
}
}
},
"RelShipToDbtr": {
"type": "string",
"description": "Indicates the relationship between the Sender and Receiver.",
"enum": [
"BRAN",
"CUST",
"FRAN",
"HOLD",
"PART",
"SUBS",
"SUPP"
]
},
"RelShipToCdtr": {
"type": "string",
"description": "Indicates the relationship between the Sender and Receiver.",
"enum": [
"BRAN",
"CUST",
"FRAN",
"HOLD",
"PART",
"SUBS",
"SUPP"
]
},
"Rprtv": {
"type": "object",
"description": "Indicates the name of the organization's representative.",
"properties": {
"StrdNm": {
"type": "object",
"description": "Allows the name of the organization's representative to be held in a structured format.",
"$ref": "#/definitions/name"
}
}
}
}
},
"PrvtId": {
"type": "object",
"description": "Unique and unambiguous identification of a person, e.g., passport.",
"properties": {
"DtAndPlcOfBirth": {
"type": "object",
"description": "Date and place of birth of a person.",
"properties": {
"BirthDt": {
"description": "Information that identifies the date of Birth in ISO Date format (YYYY-MM-DD) for the party.",
"type": "string",
"format": "date-time"
},
"PrvcOfBirth": {
"description": "Information that locates and identifies the Province of birth for the party.",
"type": "string",
"maxLength": 35
},
"CityOfBirth": {
"description": "Information that locates and identifies the city of birth for the party.",
"type": "string",
"maxLength": 35
},
"CtryOfBirth": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Information that locates and identifies the country of birth for the party, as defined by postal services. Use Alpha-2 Code as defined in the ISO CountryCode ISO 3166-1 list.",
"$ref": "#/definitions/country"
}
}
},
"Othr": {
"type": "array",
"description": "An array of objects, each containing the unique identification of a party, as assigned by an institution, using an identification scheme.",
"properties": {
"Id": {
"description": "Value to be used to identify the party",
"type": "string",
"maxLength": 35
},
"Issr": {
"description": "Information for the Entity that assigns the identification.",
"type": "string",
"maxLength": 35
},
"SchmeNm": {
"type": "object",
"description": "Name of the identification scheme used to identify an individual.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ISO20022 ExternalPersonIdentification1Code List ",
"enum": [
"ARNU",
"CCPT",
"CUST",
"DRLC",
"EMPL",
"NIDN",
"SOS",
"TELE",
"TXID"
]
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"DtOfIss": {
"type": "string",
"description": "Date of Issue for Passport",
"format": "date-time"
},
"DtOfExpr": {
"type": "string",
"description": "Date of Expiry for Passport",
"format": "date-time"
},
"MrzNb": {
"description": "Machine Readable Zone for Passport",
"type": "string",
"maxLength": 88,
"pattern": "/([A-Z])([A-Z0-9<])([A-Z]{3})([A-Z<]{39})\n([A-Z0-9<]{9})([0-9])([A-Z]{3})([0-9]{6})([0-9])([MF<])([0-9]{6})([0-9])([A-Z0-9<]{14})([0-9])([0-9])/im"
}
}
},
"Gender":{
"description": "Information that captures the ender of a party. Supported values: Male, Female, Other.",
"type": "string",
"maxLength": 6
},
"Profession": {
"description": "Information that captures the occupation of a party.",
"type": "string",
"maxLength": 35
},
"RelShipToDbtr": {
"description": "Relationship of the receiving party to the sending party.",
"type": "string",
"enum":[
"CHIL",
"CUST",
"EMPL",
"EXSP",
"FREN",
"OTHR",
"PARE",
"PART",
"RELA",
"SELF",
"SIBL",
"SPOU",
"VEND"
]
},
"Ntlty": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Country of nationality of the party. Use ISO Country Code for value.",
"maxLength": 3
},
"Residence": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Country of residence of the party. Use ISO Country Code for value.",
"maxLength": 3
},
"Citizenship": {
"type": "object",
"properties": {
"Ntlty": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Nationality of the party. Use ISO Country Code for values.",
"maxLength": 3
},
"MnrId": {
"description": "Indicates whether the party is a minor. Provide a value of Yes or No.",
"type": "string",
"maxLength": 3
},
"StartDt": {
"description": "Start date of citizenship in ISO Date format (YYYY-MM-DD) for the party.",
"type": "string",
"format": "date-time"
},
"EndDt": {
"description": "End date of citizenship in ISO Date format (YYYY-MM-DD) for the party.",
"type": "string",
"format": "date-time"
}
}
}
}
}
}
},
"contact_details": {
"type": "object",
"description": "Contact Details for the individual or organization",
"properties": {
"CtctDtls": {
"type": "object",
"description": "Set of elements used to indicate how to contact the party.",
"properties": {
"NmPrfx": {
"type": "string",
"description": "List based on ISO 20022 NamePrefix1Code List",
"enum": [
"DOCT",
"MIST",
"MISS",
"MADM"
]
},
"Nm": {
"type": "string",
"description": "Name by which a party is known and which is usually used to identify that party.",
"maxLength": 140
},
"PhneNb": {
"type": "string",
"description": "Phone Number",
"$ref": "#/definitions/phone_number"
},
"MobNb": {
"type": "string",
"description": "Mobile Phone Number",
"$ref": "#/definitions/phone_number"
},
"FaxNb": {
"type": "string",
"description": "Fax Number",
"$ref": "#/definitions/phone_number"
},
"EmailAdr": {
"type": "string",
"description": "Address for electronic mail (e-mail).",
"maxLength": 2048
},
"Othr": {
"type": "string",
"description": "Contact details in another form.",
"maxLength": 35
}
}
}
}
},
"account_name": {
"description": "Name by which the account is known and which is usually used to identify the account.",
"type": "string",
"maxLength": 140
},
"account_id": {
"type": "object",
"description": "Specifies the unique identification of an account as assigned by the account servicer.",
"properties": {
"IBAN": {
"$ref": "#/definitions/iban"
},
"Othr": {
"type": "object",
"properties": {
"Id": {
"description": "Identification assigned by an institution.",
"type": "string",
"maxLength": 34
},
"SchmeNm": {
"type": "object",
"description": "Name of the account identification scheme.",
"properties": {
"Cd": {
"$ref": "#/definitions/external_account_id"
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"Issr": {
"type": "string",
"description": "Entity that assigns the identification.",
"maxLength": 35
}
}
}
}
},
"account_type": {
"type": "object",
"description": "Nature or use of the account.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ISO20022 ExternalCashAccountType1Code List",
"$ref": "#/definitions/externalcashaccount"
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"financial_institution": {
"type": "object",
"description": "Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.",
"properties": {
"BICFI": {
"$ref": "#/definitions/bic"
},
"Nm": {
"$ref": "#/definitions/fullname"
},
"ClrSysMmbId": {
"type": "object",
"description": "Information used to identify a member within a clearing system.",
"properties": {
"MmbId": {
"description": "Contains the routing code / sort code for the institution",
"type": "string",
"maxLength": 35
},
"ClrSysId": {
"type": "object",
"description": "Information used to identify a member within a clearing system.",
"properties": {
"Cd": {
"$ref": "#/definitions/externalclearingsystem"
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
}
}
},
"PstlAdr": {
"$ref": "#/definitions/address"
},
"Othr": {
"type": "object",
"description": "Unique identification of an agent, as assigned by an institution, using an identification scheme.",
"properties": {
"Id": {
"type": "string",
"description": "Unique and unambiguous identification of a person."
},
"SchmeNm": {
"type": "object",
"description": "Name of the agent identification scheme.",
"properties": {
"Cd": {
"type": "string",
"description": "Based on list for externalfinancialinstitution1code defined by ISO 20022"
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"Issr": {
"type": "string",
"description": "Entity that assigns the identification.",
"maxLength": 35
}
}
}
}
},
"branch_id": {
"type": "object",
"description": "Identifies a specific branch of a financial institution.",
"properties": {
"Id": {
"type": "string",
"description": "Unique and unambiguous identification of a branch of a financial institution.",
"maxLength": 35
},
"Nm": {
"type": "string",
"description": "Name for the Branch",
"$ref": "#/definitions/fullname"
},
"PstlAdr": {
"type": "object",
"description": "Address for the Branch",
"$ref": "#/definitions/address"
}
}
}
},
"type": "object",
"properties": {
"required": [
"version",
"accepting_client_id",
"connector_role",
"locking_client_id"
],
"version": {
"type": "string",
"description": "Defines which version of the Payment Object Supporting Information is used",
"maxLength": 10
},
"receiver_version": {
"description": "Specification for the RPO version provided by the Receiving Member.",
"type": "string",
"maxLength": 20
},
"locking_client_id": {
"description": "This is a system populated field.",
"type": "string"
},
"connector_role": {
"description": "This is a system populated field.",
"type": "string"
},
"return_payment": {
"type": "string",
"description": "The payment_id of the original payment specified in the request."
},
"return_reasons": {
"type": "array",
"description": "Fields that describe the reason for the return and other metadata related to the return. These are the same fields specified in the request.",
"items": [
{
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of return, as defined in the RippleNet Rulebook."
},
"code": {
"type": "string",
"description": "ISO 20022 code for the return, as defined in the RippleNet Rulebook."
},
"reason": {
"type": "string",
"description": "ISO 20022 reason for the return, as defined in the RippleNet Rulebook."
}
}
}
]
}
]
},
"accepting_client_id": {
"description": "This is a system populated field.",
"type": "string"
},
"external_id": {
"description": "This is a sender or receiver populated field, used for their internal usage purposes.",
"type": "string"
},
"SourceOfCash": {
"$ref": "#/definitions/SourceOfCash"
},
"PmtId": {
"type": "object",
"description": "Set of elements used to reference a payment instruction.",
"properties": {
"InstrId": {
"description": "Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction.",
"type": "string",
"maxLength": 35
},
"TxId": {
"type": "string",
"description": "Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain.",
"maxLength": 35
},
"ClrSysRef": {
"type": "string",
"description": "Unique reference, as assigned by a clearing system, to unambiguously identify the instruction.",
"maxLength": 35
},
"Uetr": {
"type": "string",
"pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$",
"description": "Unique End-to-end Transaction Reference, generated by the Payer and passed through, without modification by the payment participants through to the beneficiary.",
"maxLength": 36
}
}
},
"PmtTpInf": {
"type": "object",
"description": "Set of elements used to further specify the type of transaction.",
"properties": {
"InstrPrty": {
"type": "string",
"description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. List based on ISO20022 Priority2Code List",
"enum": [
"HIGH",
"NORM"
]
},
"ClrChanl": {
"type": "string",
"description": "List based on ISO20022 ClearingChannel2Code List",
"enum": [
"RTGS",
"RTNS",
"MPNS",
"BOOK"
]
},
"CtgyPurp": {
"type": "object",
"description": "Specifies the high level purpose of the instruction based on a set of pre-defined categories.",
"properties": {
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
},
"Cd": {
"$ref": "#/definitions/levelofpurpose"
}
}
},
"SvcLvl": {
"type": "object",
"description": "Agreement under which or rules under which the transaction should be processed.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ISO20022 List ExternalServiceLevel1Code",
"enum": [
"BKTR",
"NPCA",
"NUGP",
"NURG",
"PRPT",
"SDVA",
"SEPA",
"SVDE",
"URGP",
"URNS",
"G001",
"G002",
"G003",
"G004"
]
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"LclInstrm": {
"type": "object",
"description": "User community specific instrument.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ISO20022 List ExternalLocalInstrument1Code",
"enum": [
"DDMC",
"DDMP",
"DDMU",
"TRF",
"82",
"83",
"CPP",
"RTR",
"GST",
"DDT",
"RDD",
"CHN",
"STR",
"SDD",
"SRT",
"SRD",
"SCN",
"SGT",
"CARD",
"05",
"04",
"ISE",
"BSE",
"IN",
"58",
"19",
"85",
"08",
"89",
"60",
"RIBA",
"RIDO",
"RIDV",
"IDEAL",
"INSTNT01",
"INSTTC01",
"INSTIDEAL",
"INSTNT01IDEAL",
"INSTTC01IDEAL",
"NLDO",
"NLUP",
"ACCEPT",
"SDN",
"NLGOV",
"0090",
"0091",
"0092",
"0002",
"0221",
"0224",
"0226",
"0225",
"0222",
"0227",
"0220",
"0223",
"0001",
"0000",
"ONCL",
"SDCL",
"DDNR",
"DDFA",
"CORE",
"B2BAMIPM",
"B2B",
"CR1AMIPM",
"CORAMIPM",
"COR1",
"FADAMIPM",
"CLSCCPERX",
"CLSCCPLCH",
"INST",
"ADD",
"UDD",
"CCI",
"BTR",
"CKS",
"CTR",
"CTP",
"DEP",
"FFR",
"FFS",
"SVC",
"DRW",
"DRB",
"DRC",
"IAT",
"CCD",
"CTX",
"PPD",
"CIE",
"RCK",
"ARC",
"WEB",
"POP",
"POS",
"TEL",
"BPA",
"IPA",
"ASTI",
"BACP",
"MANP",
"SBTI",
"ICMC",
"PERI"
]
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
}
}
},
"ChrgBr": {
"description": "Specifies which party/parties will bear the charges associated with the processing of the payment transaction. Use ISO ChargeBearerType1Code list, supported values are CRED, DEBT & SHAR.",
"type": "string",
"enum": [
"DEBT",
"CRED",
"SHAR"
]
},
"UltmtDbtr": {
"type": "object",
"description": "Ultimate party that owes an amount of money to the (ultimate) creditor.",
"properties": {
"Nm": {
"type": "string",
"description": "Allows the name of the Ultimate Debtor to be held as a single value.",
"$ref": "#/definitions/fullname"
},
"StrdNm": {
"type": "object",
"description": "Allows the name of the Ultimate Debtor to be held in a structured format.",
"$ref": "#/definitions/name"
},
"PstlAdr": {
"type": "object",
"description": "Allows the address of the Ultimate Debtor to be held.",
"$ref": "#/definitions/address"
},
"CtctDtls": {
"type": "object",
"description": "Allows the Country of Residence of the Ultimate Debtor to be held.",
"$ref": "#/definitions/contact_details"
},
"Id": {
"type": "object",
"description": "Unique and unambiguous way to identify the Ultimate Debtor.",
"$ref": "#/definitions/id_section"
}
}
},
"InitgPty": {
"type": "object",
"description": "Party that initiates the payment.",
"properties": {
"Nm": {
"type": "string",
"description": "Allows the name of the Initiating Party to be held as a single value.",
"$ref": "#/definitions/fullname"
},
"PstlAdr": {
"type": "object",
"description": "Allows the address of the Initiating Party to be held.",
"$ref": "#/definitions/address"
},
"Id": {
"type": "object",
"description": "Unique and unambiguous way to identify the Initiating Party.",
"$ref": "#/definitions/id_section"
},
"CtryOfRes": {
"type": "object",
"description": "Allows the Country of Residence of the Initiating Party to be held.",
"$ref": "#/definitions/country"
},
"CtctDtls": {
"type": "object",
"description": "Allows the contact of the Initiating Party to be held.",
"$ref": "#/definitions/contact_details"
}
}
},
"Dbtr": {
"type": "object",
"description": "Party that owes an amount of money to the (ultimate) creditor.",
"properties": {
"Nm": {
"type": "string",
"description": "Allows the name of the Debtor to be held as a single value.",
"$ref": "#/definitions/fullname"
},
"StrdNm": {
"type": "object",
"description": "Allows the name of the Debtor to be held in a structured format.",
"$ref": "#/definitions/name"
},
"CtryOfRes": {
"type": "object",
"description": "Allows the Country of Residence of the Debtor to be held.",
"$ref": "#/definitions/country"
},
"PstlAdr": {
"type": "object",
"description": "Allows the address of the Debtor to be held.",
"$ref": "#/definitions/address"
},
"Id": {
"type": "object",
"description": "Unique and unambiguous way to identify the Debtor.",
"$ref": "#/definitions/id_section"
},
"CtctDtls": {
"type": "object",
"description": "Allows the contact of the Debtor to be held.",
"$ref": "#/definitions/contact_details"
}
}
},
"DbtrAcct": {
"type": "object",
"description": "Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.",
"properties": {
"Nm": {
"type": "string",
"description": "Name by which the account is known and which is usually used to identify the Debtor account.",
"$ref": "#/definitions/account_name"
},
"Ccy": {
"type": "string",
"description": "Currency for the Debtor Account",
"$ref": "#/definitions/currency"
},
"Id": {
"type": "object",
"description": "Nature or use of the Debtor account.",
"$ref": "#/definitions/account_id"
},
"Tp": {
"type": "object",
"description": "Nature or use of the Debtor account.",
"$ref": "#/definitions/account_type"
}
}
},
"DbtrAgt": {
"type": "object",
"description": "Financial institution servicing an account for the debtor.",
"properties": {
"FinInstnId": {
"type": "object",
"description": "Allows the details of the Debtor Agent to be held",
"$ref": "#/definitions/financial_institution"
},
"BrnchId": {
"type": "object",
"description": "Allows the details of the Debtor Agent Branch to be held",
"$ref": "#/definitions/branch_id"
}
}
},
"DbtrAgtAcct": {
"type": "object",
"description": "Unambiguous identification of the account of the debtor agent at its servicing agent in the payment chain.",
"properties": {
"Id": {
"type": "object",
"description": "Unique and unambiguous identification for the account between the account owner and the account servicer.",
"$ref": "#/definitions/account_id"
},
"Tp":{
"type": "object",
"description": "Nature or use of the account.",
"$ref": "#/definitions/account_type"
},
"Ccy": {
"type": "string",
"description": "Code allocated to identify a currency for the Debtor Agent Account. Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account.",
"$ref": "#/definitions/currency",
"pattern": "^[A-Z]{3,3}$"
},
"Nm":{
"type": "string",
"description": "Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account. The account name is different from the account owner name. The account name is used in certain user communities to provide a means of identifying the account, in addition to the account owner's identity and the account number.",
"$ref": "#/definitions/account_name",
"maxLength": 140
},
"Prxy":{
"type": "object",
"description": "Specifies an alternate assumed name for the identification of the account.",
"properties": {
"Id": {
"type": "object",
"description": "Unique and unambiguous identification for the account between the account owner and the account servicer.",
"$ref": "#/definitions/account_id"
},
"Tp":{
"type": "object",
"description": "Nature or use of the account.",
"$ref": "#/definitions/account_type"
}
}
}
}
},
"CdtrAgt": {
"type": "object",
"description": "Financial institution servicing an account for the creditor.",
"properties": {
"FinInstnId": {
"type": "object",
"description": "Allows the details of the Creditor Agent to be held",
"$ref": "#/definitions/financial_institution"
},
"BrnchId": {
"type": "object",
"description": "Allows the details of the Creditor Agent Branch to be held",
"$ref": "#/definitions/branch_id"
}
}
},
"Cdtr": {
"type": "object",
"description": "Party to which an amount of money is due.",
"properties": {
"Nm": {
"type": "string",
"description": "Allows the name of the Creditor to be held as a single value.",
"$ref": "#/definitions/fullname"
},
"StrdNm": {
"type": "object",
"description": "Allows the name of the Creditor to be held in a structured format.",
"$ref": "#/definitions/name"
},
"CtryOfRes": {
"type": "object",
"description": "Allows the Country of Residence of the Creditor to be held.",
"$ref": "#/definitions/country"
},
"PstlAdr": {
"type": "object",
"description": "Allows the address of the Creditor to be held.",
"$ref": "#/definitions/address"
},
"CtctDtls": {
"type": "object",
"description": "Allows the contact of the Creditor to be held.",
"$ref": "#/definitions/contact_details"
},
"Id": {
"type": "object",
"description": "Unique and unambiguous way to identify the Creditor.",
"$ref": "#/definitions/id_section"
}
}
},
"CdtrAcct": {
"type": "object",
"description": "Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.",
"properties": {
"Nm": {
"type": "string",
"description": "Name by which the account is known and which is usually used to identify the Creditor account.",
"$ref": "#/definitions/account_name"
},
"Ccy": {
"type": "string",
"description": "Currency for the Creditor Account",
"$ref": "#/definitions/currency"
},
"Id": {
"type": "object",
"description": "Identifier for the Creditor account.",
"$ref": "#/definitions/account_id"
},
"Tp": {
"type": "object",
"description": "Nature or use of the Creditor account.",
"$ref": "#/definitions/account_type"
}
}
},
"UltmtCdtr": {
"type": "object",
"description": "Ultimate party to which an amount of money is due.",
"properties": {
"Nm": {
"type": "string",
"description": "Allows the name of the Ultimate Creditor to be held as a single value.",
"$ref": "#/definitions/fullname"
},
"StrdNm": {
"type": "object",
"description": "Allows the name of the Ultimate Creditor to be held in a structured format.",
"$ref": "#/definitions/name"
},
"CtryOfRes": {
"type": "object",
"description": "Allows the Country of Residence of the Utlimate Creditor to be held.",
"$ref": "#/definitions/country"
},
"PstlAdr": {
"type": "object",
"description": "Allows the address of the Ultimate Creditor to be held.",
"$ref": "#/definitions/address"
},
"CtctDtls": {
"type": "object",
"description": "Allows the contact of the Ultimate Creditor to be held.",
"$ref": "#/definitions/contact_details"
},
"Id": {
"type": "object",
"description": "Unique and unambiguous way to identify the Ultimate Creditor.",
"$ref": "#/definitions/id_section"
}
}
},
"InstForCdtrAgt": {
"type": "object",
"description": "Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.",
"properties": {
"Cd": {
"type": "string",
"description": "List based on ISO20022 Instruction3Code List",
"enum": [
"CHQB",
"HOLD",
"PHOB",
"TELB"
]
},
"InstrInf": {
"type": "string",
"description": "Further information complementing the coded instruction or instruction to the creditor's agent that is bilaterally agreed or specific to a user community.",
"maxLength": 140
}
}
},
"Purp": {
"type": "object",
"description": "Underlying reason for the payment transaction.",
"properties": {
"Cd": {
"type": "string",
"description": "Underlying reason for the payment transaction, as published in an external purpose code list. Based on ISO20022 ExternalPurpose1Code List",
"enum": [
"BKDF",
"BKFE",
"BKFM",
"BKIP",
"BKPP",
"CBLK",
"CDCB",
"CDCD",
"CDCS",
"CDDP",
"CDOC",
"CDQC",
"ETUP",
"FAMI",
"FCOL",
"MTUP",
"ACCT",
"CASH",
"COLL",
"CSDB",
"DEPT",
"INTC",
"INTP",
"LIMA",
"NETT",
"BFWD",
"CCIR",
"CCPC",
"CCPM",
"CCSM",
"CRDS",
"CRPR",
"CRSP",
"CRTL",
"EQPT",
"EQUS",
"EXPT",
"EXTD",
"FIXI",
"FWBC",
"FWCC",
"FWSB",
"FWSC",
"MARG",
"MBSB",
"MBSC",
"MGCC",
"MGSC",
"MISC",
"OCCC",
"OPBC",
"OPCC",
"OPSB",
"OPSC",
"OPTN",
"OTCD",
"REMT",
"REPO",
"RPBC",
"RPCC",
"RPSB",
"RPSC",
"RVPO",
"SBSC",
"SCIE",
"SCIR",
"SCRP",
"SHBC",
"SHCC",
"SHSL",
"SLEB",
"SLOA",
"SWBC",
"SWCC",
"SWPT",
"SWSB",
"SWSC",
"TBAS",
"TBBC",
"TBCC",
"TRCP",
"AGRT",
"AREN",
"BEXP",
"BOCE",
"COMC",
"CPYR",
"GDDS",
"GDSV",
"GSCB",
"LICF",
"MP2B",
"POPE",
"ROYA",
"SCVE",
"SUBS",
"SUPP",
"TRAD",
"CHAR",
"COMT",
"MP2P",
"ECPG",
"ECPR",
"ECPU",
"EPAY",
"CLPR",
"COMP",
"DBTC",
"GOVI",
"GIFT",
"HLRP",
"INPC",
"INSU",
"INTE",
"LBRI",
"LIFI",
"LOAN",
"LOAR",
"PENO",
"PPTI",
"RELG",
"RINP",
"TRFD",
"FORW",
"FXNT",
"ADMG",
"ADVA",
"BCDM",
"BCFG",
"BLDM",
"BNET",
"CBFF",
"CBFR",
"CCRD",
"CDBL",
"CFEE",
"CGDD",
"CORT",
"COST",
"CPKC",
"DCRD",
"DSMT",
"DVPM",
"EDUC",
"FACT",
"FAND",
"FCPM",
"FEES",
"GOVT",
"ICCP",
"IDCP",
"IHRP",
"INSM",
"IVPT",
"MCDM",
"MCFG",
"MSVC",
"NOWS",
"OCDM",
"OCFG",
"OFEE",
"OTHR",
"PADD",
"PTSP",
"RCKE",
"RCPT",
"REBT",
"REFU",
"RENT",
"REOD",
"RIMB",
"RPNT",
"RRBN",
"RRTP",
"RVPM",
"SLPI",
"SPLT",
"STDY",
"TBAN",
"TBIL",
"TCSC",
"TELI",
"TMPG",
"TPRI",
"TPRP",
"TRNC",
"TRVC",
"WEBI",
"ANNI",
"CAFI",
"CFDI",
"CMDT",
"DERI",
"DIVD",
"FREX",
"HEDG",
"INVS",
"PRME",
"SAVG",
"SECU",
"SEPI",
"TREA",
"UNIT",
"FNET",
"FUTR",
"ANTS",
"CVCF",
"DMEQ",
"DNTS",
"HLTC",
"HLTI",
"HSPC",
"ICRF",
"LTCF",
"MAFC",
"MDCS",
"VIEW",
"CDEP",
"SWFP",
"SWPP",
"SWRS",
"SWUF",
"ADCS",
"AEMP",
"ALLW",
"ALMY",
"BBSC",
"BECH",
"BENE",
"BONU",
"CCHD",
"COMM",
"CSLP",
"GFRP",
"GVEA",
"GVEB",
"GVEC",
"GVED",
"GWLT",
"HREC",
"PAYR",
"PEFC",
"PENS",
"PRCP",
"RHBS",
"SALA",
"SSBE",
"LBIN",
"LCOL",
"LFEE",
"LMEQ",
"LMFI",
"LMRK",
"LREB",
"LREV",
"LSFL",
"ESTX",
"FWLV",
"GSTX",
"HSTX",
"INTX",
"NITX",
"PTXP",
"RDTX",
"TAXS",
"VATX",
"WHLD",
"TAXR",
"B112",
"BR12",
"TLRF",
"TLRR",
"AIRB",
"BUSB",
"FERB",
"RLWY",
"TRPT",
"CBTV",
"ELEC",
"ENRG",
"GASB",
"NWCH",
"NWCM",
"OTLC",
"PHON",
"UBIL",
"WTER",
"SERV",
"HLST",
"INPR",
"INSC",
"RRCT",
"IPAY",
"IPCA",
"IPDO",
"IPEA",
"IPEC",
"IPEW",
"IPPS",
"IPRT",
"IPU2",
"IPUW",
"SPSP",
"MARF"
]
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"RgltryRptg": {
"type": "object",
"description": "Information needed due to regulatory and statutory requirements.",
"properties": {
"DbtCdtRptgInd": {
"type": "string",
"description": "Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.",
"enum": [
"CRED",
"DEBT",
"BOTH"
]
},
"Authrty": {
"type": "object",
"description": "Entity requiring the regulatory reporting information.",
"properties": {
"Nm": {
"type": "string",
"description": "Name of the entity requiring the regulatory reporting information.",
"maxLength": 140
},
"Ctry": {
"type": "string",
"description": "Country where Entity resides",
"$ref": "#/definitions/country"
}
}
},
"Dtls": {
"type": "object",
"description": "Set of elements used to provide details on the regulatory reporting information.",
"properties": {
"Tp": {
"type": "string",
"description": "Specifies the type of the information supplied in the regulatory reporting details.",
"maxLength": 35
},
"Dt": {
"type": "string",
"description": "Date related to the specified type of regulatory reporting details.",
"format": "date-time"
},
"Ctry": {
"$ref": "#/definitions/country"
},
"Cd": {
"type": "string",
"description": "Specifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.",
"maxLength": 10
},
"Amt": {
"type": "object",
"description": "Amount of money to be reported for regulatory and statutory requirements.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"Ccy": {
"$ref": "#/definitions/currency"
}
}
},
"Inf": {
"type": "string",
"description": "Additional details that cater for specific domestic regulatory requirements.",
"maxLength": 35
}
}
}
}
},
"RltdRmtInf": {
"type": "object",
"description": "Provides information related to the handling of the remittance information by any of the agents in the transaction processing chain.",
"properties": {
"RmtId": {
"type": "string",
"description": "Unique identification, as assigned by the initiating party, to unambiguously identify the remittance information sent separately from the payment instruction, such as a remittance advice.",
"maxLength": 35
},
"RmtLctnDtls": {
"type": "object",
"description": "Set of elements used to provide information on the location and/or delivery of the remittance information.",
"properties": {
"Mtd": {
"type": "string",
"description": "List based on ISO 20022 RemittanceLocationMethod2Code List",
"enum": [
"FAXI",
"EDIC",
"URID",
"EMAL",
"POST",
"SMSM"
]
},
"ElctrncAdr": {
"type": "string",
"description": "Electronic address to which an agent is to send the remittance information.",
"maxLength": 2048
},
"PstlAdr": {
"type": "object",
"description": "Postal address to which an agent is to send the remittance information.",
"properties": {
"Nm": {
"$ref": "#/definitions/fullname"
},
"Adr": {
"$ref": "#/definitions/address"
}
}
}
}
}
}
},
"RmtInf": {
"type": "object",
"description": "Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.",
"properties": {
"Ustrd": {
"description": "Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. Please note, should new lines be required in this field, \n should be used to denote a new line.",
"type": "string",
"maxLength": 140
},
"Strd": {
"type": "object",
"description": "Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in a structured form.",
"properties": {
"RfrdDocInf": {
"type": "object",
"description": "Provides the identification and the content of the referred document.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of referred document.",
"properties": {
"CdOrPrtry": {
"type": "object",
"description": "Provides the type details of the referred document.",
"properties": {
"Cd": {
"type": "string",
"description": "Document type in a coded form. As defined in ISO list DocumentType6Code ",
"enum": [
"MSIN",
"CNFA",
"DNFA",
"CINV",
"CREN",
"DEBN",
"HIRI",
"SBIN",
"CMCN",
"SOAC",
"DISP",
"BOLD",
"VCHR",
"AROI",
"TSUT",
"PUOR"
]
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary values",
"maxLength": 35
}
},
"Issr": {
"type": "string",
"description": "Identification of the issuer of the reference document type.",
"maxLength": 35
}
}
}
},
"Nb": {
"type": "string",
"description": "Unique and unambiguous identification of the referred document.",
"maxLength": 35
},
"RltdDt": {
"type": "string",
"description": "Date associated with the referred document.",
"format": "date-time"
},
"LineDtls": {
"type": "array",
"description": "Set of elements used to provide the content of the referred document line.",
"items": [
{
"Id": {
"type": "object",
"description": "Provides identification of the document line.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of referred document line identification.",
"properties": {
"CdOrPrtry": {
"type": "object",
"description": "Provides the type details of the referred document line identification.",
"properties": {
"Cd": {
"type": "string",
"description": "Line identification type in a coded form. Uses ISO list ExternalDocumentLineType1Code",
"enum": [
"ADPI",
"AISB",
"ASNB",
"CTNB",
"DBSP",
"EANN",
"EINB",
"GSNB",
"HIBC",
"ISBN",
"LTNB",
"MDNB",
"PRNB",
"PTCD",
"SKNB",
"STNB",
"TONB",
"UPCC",
"UPNB"
]
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
},
"Issr": {
"type": "string",
"description": "Identification of the issuer of the reference document line identification type.",
"maxLength": 35
}
},
"Nb": {
"type": "string",
"description": "Identification of the type specified for the referred document line.",
"maxLength": 35
},
"RltdDt": {
"type": "string",
"description": "Date associated with the referred document line.",
"format": "date-time"
}
}
},
"Desc": {
"type": "string",
"description": "Description associated with the document line.",
"maxLength": 2048
},
"Amt": {
"type": "object",
"description": "Provides details on the amounts of the document line.",
"properties": {
"DuePyblAmt": {
"type": "object",
"description": "Amount specified is the exact amount due and payable to the creditor.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"DscntApldAmt": {
"type": "object",
"description": "Amount of discount to be applied to the amount due and payable to the creditor.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of the amount.",
"properties": {
"Cd": {
"type": "string",
"description": "Specifies the amount type, in a coded form. Based on ISO list ExternalDiscountAmountType1Code",
"enum": [
"APDS",
"STDS",
"TMDS"
]
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"Amt": {
"type": "object",
"description": "Amount of money, which has been typed",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
}
}
},
"CdtNoteAmt": {
"type": "object",
"description": "Amount of a credit note.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"TaxAmt": {
"type": "object",
"description": "Amount of the tax.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of the amount.",
"properties": {
"Cd": {
"type": "string",
"description": "Specifies the amount type, in a coded form. Based on ISO ExternalTaxAmountType1Code list",
"enum": [
"CITY",
"CNTY",
"LOCL",
"PROV",
"STAT"
]
},
"Prtry": {
"type": "string",
"description": "Specifies the amount type, in a free-text form.",
"maxLength": 35
}
}
},
"Amt": {
"type": "object",
"description": "Amount of money, which has been typed",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
}
}
},
"AdjstmntAmtAndRsn": {
"type": "object",
"description": "Specifies detailed information on the amount and reason of the adjustment.",
"properties": {
"Amt": {
"type": "object",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"CdtDbtInd": {
"type": "string",
"description": "Specifies whether the adjustment must be substracted or added to the total amount.",
"enum": [
"CRDT",
"DBIT"
]
},
"Rsn": {
"type": "string",
"description": "Specifies the reason for the adjustment.",
"maxLength": 4
},
"AddtlInf": {
"type": "string",
"description": "Provides further details on the document adjustment.",
"maxLength": 140
}
}
},
"RmtdAmt": {
"type": "object",
"description": "Amount of money remitted.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
}
}
}
}
}
}]
}
}
},
"RfrdDocAmt": {
"type": "object",
"description": "Provides details on the amounts of the referred document.",
"properties": {
"DuePyblAmt": {
"type": "object",
"description": "Amount specified is the exact amount due and payable to the creditor.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"DscntApldAmt": {
"type": "object",
"description": "Amount specified for the referred document is the amount of discount to be applied to the amount due and payable to the creditor.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of the amount.",
"properties": {
"Cd": {
"type": "string",
"description": "Specifies the amount type, in a coded form. Based on ISO ExternalDiscountAmountType1Code",
"enum": [
"APDS",
"STDS",
"TMDS"
]
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"Amt": {
"type": "object",
"description": "Amount of money, which has been typed.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
}
}
},
"CdtNoteAmt": {
"type": "object",
"description": "Amount specified for the referred document is the amount of a credit note.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"TaxAmt": {
"type": "object",
"description": "Quantity of cash resulting from the calculation of the tax.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of the amount. Based on the ISO ExternalTaxAmountType1Code list",
"properties": {
"Cd": {
"type": "string",
"description": "Specifies the amount type, in a coded form. Based on the ISO ExternalTaxAmountType1Code list",
"enum": [
"CITY",
"CNTY",
"LOCL",
"PROV",
"STAT"
]
},
"Prtry": {
"type": "string",
"description": "Field to support proprietary value",
"maxLength": 35
}
}
},
"Amt": {
"type": "object",
"description": "Amount of money, which has been typed.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
}
}
},
"AdjstmntAmtAndRsn": {
"type": "object",
"description": "Specifies detailed information on the amount and reason of the document adjustment.",
"properties": {
"Amt": {
"type": "object",
"description": "Amount of money of the document adjustment.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"CdtDbtInd": {
"type": "string",
"description": "Specifies whether the adjustment must be substracted or added to the total amount.",
"enum": [
"CRDT",
"DBIT"
]
},
"Rsn": {
"type": "string",
"description": "Specifies the reason for the adjustment.",
"maxLength": 4
},
"AddtlInf": {
"type": "string",
"description": "Provides further details on the document adjustment.",
"maxLength": 140
}
}
},
"RmtdAmt": {
"type": "object",
"description": "Amount of money remitted for the referred document.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
}
}
},
"CdtrRefInf": {
"type": "object",
"description": "Reference information provided by the creditor to allow the identification of the underlying documents.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of creditor reference.",
"properties": {
"CdOrPrtry": {
"type": "object",
"description": "Coded or proprietary format creditor reference type.",
"properties": {
"Cd": {
"type": "string",
"description": "Type of creditor reference, in a coded form. Based on ISO DocumentType3Code list",
"enum": [
"RADM",
"RPIN",
"FXDR",
"DISP",
"PUOR",
"SCOR"
]
},
"Prtry": {
"type": "string",
"description": "Creditor reference type, in a proprietary form.",
"maxLength": 35
}
}
},
"Issr": {
"type": "string",
"description": "Entity that assigns the credit reference type.",
"maxLength": 35
}
}
},
"Ref": {
"type": "string",
"description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.",
"maxLength": 35
}
}
},
"Invcr": {
"type": "object",
"description": "Identification of the organization issuing the invoice, when it is different from the creditor or ultimate creditor.",
"properties": {
"Nm": {
"$ref": "#/definitions/fullname"
},
"StrdNm": {
"$ref": "#/definitions/name"
},
"CtryOfRes": {
"$ref": "#/definitions/country"
},
"PstlAdr": {
"$ref": "#/definitions/address"
},
"Id": {
"$ref": "#/definitions/id_section"
},
"CtctDtls": {
"$ref": "#/definitions/contact_details"
}
}
},
"Invcee": {
"type": "object",
"description": "Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.",
"properties": {
"Nm": {
"$ref": "#/definitions/fullname"
},
"StrdNm": {
"$ref": "#/definitions/name"
},
"CtryOfRes": {
"$ref": "#/definitions/country"
},
"PstlAdr": {
"$ref": "#/definitions/address"
},
"Id": {
"$ref": "#/definitions/id_section"
},
"CtctDtls": {
"$ref": "#/definitions/contact_details"
}
}
},
"TaxRmt": {
"type": "object",
"description": "Provides remittance information about a payment made for tax-related purposes.",
"properties": {
"Cdtr": {
"type": "object",
"description": "Party on the credit side of the transaction to which the tax applies.",
"properties": {
"TaxId": {
"type": "string",
"description": "Tax identification number of the creditor.",
"maxLength": 35
},
"RegnId": {
"type": "string",
"description": "Unique identification, as assigned by an organization, to unambiguously identify a party.",
"maxLength": 35
},
"TaxTp": {
"type": "string",
"description": "Type of tax payer.",
"maxLength": 35
}
}
},
"Dbtr": {
"type": "object",
"description": "Identifies the party on the debit side of the transaction to which the tax applies.",
"properties": {
"TaxId": {
"type": "string",
"description": "Tax identification number of the debtor.",
"maxLength": 35
},
"RegnId": {
"type": "string",
"description": "Unique identification, as assigned by an organization, to unambiguously identify a party.",
"maxLength": 35
},
"TaxTp": {
"type": "string",
"description": "Type of tax payer.",
"maxLength": 35
},
"Authstn": {
"type": "object",
"description": "Details of the authorised tax paying party.",
"properties": {
"Titl": {
"type": "string",
"description": "Title or position of debtor or the debtor's authorised representative.",
"maxLength": 35
},
"Nm": {
"type": "string",
"description": "Name of the debtor or the debtor's authorised representative.",
"maxLength": 140
}
}
}
}
},
"UltmtDbtr": {
"type": "object",
"description": "Ultimate party that owes an amount of money to the (ultimate) creditor, in this case, to the taxing authority.",
"properties": {
"TaxId": {
"type": "string",
"description": "Tax identification number of the debtor.",
"maxLength": 35
},
"RegnId": {
"type": "string",
"description": "Unique identification, as assigned by an organization, to unambiguously identify a party.",
"maxLength": 35
},
"TaxTp": {
"type": "string",
"description": "Type of tax payer.",
"maxLength": 35
},
"Authstn": {
"type": "object",
"description": "Details of the authorised tax paying party.",
"properties": {
"Titl": {
"type": "string",
"description": "Title or position of debtor or the debtor's authorised representative.",
"maxLength": 35
},
"Nm": {
"type": "string",
"description": "Name of the debtor or the debtor's authorised representative.",
"maxLength": 140
}
}
}
}
},
"AdmstnZone": {
"type": "string",
"description": "Territorial part of a country to which the tax payment is related.",
"maxLength": 35
},
"RefNb": {
"type": "string",
"description": "Tax reference information that is specific to a taxing agency.",
"maxLength": 140
},
"Mtd": {
"type": "string",
"description": "Method used to indicate the underlying business or how the tax is paid.",
"maxLength": 35
},
"TtlTaxblBaseAmt": {
"type": "object",
"description": "Total amount of money on which the tax is based.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"TtlTaxAmt": {
"type": "object",
"description": "Total amount of money as result of the calculation of the tax.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"Dt": {
"type": "string",
"description": "Date by which tax is due.",
"format": "date-time"
},
"SeqNb": {
"type": "integer",
"description": "Sequential number of the tax report."
},
"Rcrd": {
"type": "object",
"description": "Record of tax details.",
"properties": {
"Tp": {
"type": "string",
"description": "High level code to identify the type of tax details.",
"maxLength": 35
},
"Ctgy": {
"type": "string",
"description": "Specifies the tax code as published by the tax authority.",
"maxLength": 35
},
"CtgyDtls": {
"type": "string",
"description": "Provides further details of the category tax code.",
"maxLength": 35
},
"DbtrSts": {
"type": "string",
"description": "Code provided by local authority to identify the status of the party that has drawn up the settlement document.",
"maxLength": 35
},
"CertId": {
"type": "string",
"description": "Identification number of the tax report as assigned by the taxing authority.",
"maxLength": 35
},
"FrmsCd": {
"type": "string",
"description": "Identifies, in a coded form, on which template the tax report is to be provided.",
"maxLength": 35
},
"Prd": {
"type": "object",
"description": "Set of elements used to provide details on the period of time related to the tax payment.",
"properties": {
"Yr": {
"type": "string",
"description": "Year related to the tax payment.",
"format": "date-time"
},
"Tp": {
"type": "string",
"description": "Identification of the period related to the tax payment. Based on ISO TaxRecordPeriod1Code",
"enum": [
"MM01",
"MM02",
"MM03",
"MM04",
"MM05",
"MM06",
"MM07",
"MM08",
"MM09",
"MM10",
"MM11",
"MM12",
"QTR1",
"QTR2",
"QTR3",
"QTR4",
"HLF1",
"HLF2"
]
},
"FrToDt": {
"type": "object",
"description": "Range of time between a start date and an end date for which the tax report is provided.",
"properties": {
"FrDt": {
"type": "string",
"description": "Start date of the range.",
"format": "date-time"
},
"ToDt": {
"type": "string",
"description": "End date of the range.",
"format": "date-time"
}
}
}
}
},
"TaxAmt": {
"type": "object",
"description": "Set of elements used to provide information on the amount of the tax record.",
"properties": {
"Rate": {
"type": "number",
"description": "Rate used to calculate the tax. ",
"minimum": 0,
"maximum": 100,
"multiplpeOf": 1e-10
},
"TtlTaxblBaseAmt": {
"type": "object",
"description": "Amount of money on which the tax is based.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"TtlAmt": {
"type": "object",
"description": "Total amount that is the result of the calculation of the tax for the record.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"Dtls": {
"type": "object",
"description": "Set of elements used to provide details on the tax period and amount.",
"properties": {
"Prd": {
"type": "object",
"description": "Set of elements used to provide details on the period of time related to the tax payment.",
"properties": {
"Yr": {
"type": "string",
"description": "Year related to the tax payment.",
"format": "date-time"
},
"Tp": {
"type": "string",
"description": "Identification of the period related to the tax payment. Based on ISO TaxRecordPeriod1Code",
"enum": [
"MM01",
"MM02",
"MM03",
"MM04",
"MM05",
"MM06",
"MM07",
"MM08",
"MM09",
"MM10",
"MM11",
"MM12",
"QTR1",
"QTR2",
"QTR3",
"QTR4",
"HLF1",
"HLF2"
]
},
"FrToDt": {
"type": "object",
"description": "Range of time between a start date and an end date for which the tax report is provided.",
"properties": {
"FrDt": {
"type": "string",
"description": "Start date of the range.",
"format": "date-time"
},
"ToDt": {
"type": "string",
"description": "End date of the range.",
"format": "date-time"
}
}
}
}
},
"Amt": {
"type": "object",
"description": "Underlying tax amount related to the specified period.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
}
}
},
"AddtlInf": {
"type": "string",
"description": "Further details of the tax record.",
"maxLength": 140
}
}
}
}
}
}
},
"GrnshmtRmt": {
"type": "object",
"description": "Provides remittance information about a payment for garnishment-related purposes.",
"properties": {
"Tp": {
"type": "object",
"description": "Specifies the type of garnishment.",
"properties": {
"CdOrPrtry": {
"type": "object",
"description": "Provides the type details of the garnishment.",
"properties": {
"Cd": {
"type": "string",
"description": "Garnishment type in a coded form. Based on ISO ExternalGarnishmentType1Code list",
"enum": [
"GNCS",
"GNDP",
"GTPP"
]
},
"Prtry": {
"type": "string",
"description": "Proprietary identification of the type of garnishment.",
"maxLength": 35
}
}
},
"Issr": {
"type": "string",
"description": "Identification of the issuer of the garnishment type.",
"maxLength": 35
}
}
},
"Grnshee": {
"type": "object",
"description": "Ultimate party that owes an amount of money to the (ultimate) creditor, in this case, to the garnisher.",
"properties": {
"Nm": {
"$ref": "#/definitions/fullname"
},
"StrdNm": {
"$ref": "#/definitions/name"
},
"CtryOfRes": {
"$ref": "#/definitions/country"
},
"PstlAdr": {
"$ref": "#/definitions/address"
},
"Id": {
"$ref": "#/definitions/id_section"
},
"CtctDtls": {
"$ref": "#/definitions/contact_details"
}
}
},
"GrnshmyAdmstr": {
"type": "object",
"description": "Party on the credit side of the transaction who administers the garnishment on behalf of the ultimate beneficiary.",
"properties": {
"Nm": {
"$ref": "#/definitions/fullname"
},
"StrdNm": {
"$ref": "#/definitions/name"
},
"CtryOfRes": {
"$ref": "#/definitions/country"
},
"PstlAdr": {
"$ref": "#/definitions/address"
},
"Id": {
"$ref": "#/definitions/id_section"
},
"CtctDtls": {
"$ref": "#/definitions/contact_details"
}
}
},
"RefNb": {
"type": "string",
"description": "Reference information that is specific to the agency receiving the garnishment.",
"maxLength": 140
},
"Dt": {
"type": "string",
"description": "Date of payment which garnishment was taken from.",
"format": "date-time"
},
"RmtdAmt": {
"type": "object",
"description": "Amount of money remitted for the referred document.",
"properties": {
"amount": {
"type": "string",
"maxLength": 19
},
"currency": {
"$ref": "#/definitions/currency"
}
}
},
"FmlyMdcllnsrncInd": {
"type": "boolean",
"description": "Indicates if the person to whom the garnishment applies (that is, the ultimate debtor) has family medical insurance coverage available."
},
"MplyeeTermntnInd": {
"type": "boolean",
"description": "Indicates if the employment of the person to whom the garnishment applies (that is, the ultimate debtor) has been terminated."
}
}
},
"AddtlRmtInf": {
"type": "array",
"description": "Additional information, in the form of an array of strings, to complement the structured remittance information. Maximum of 4 lines to ensure consistency with the ISO20022 specification."
}
}
}
}
},
"original_message_pacs008": {
"type": "string",
"description": "Provides the ability to include the original PACS.008 message"
},
"original_message_mt103": {
"type": "string",
"description": "Provides the ability to include the original MT103 message"
}
}
}