{ "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", "definitions": { "externalclearingsystem": { "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.

Usage Guidelines:
  • Do not specify `ClrSysMmbId.ClrSysId.Cd` if you do not specify `ClrSysMmbId.MmbId`.

    Examples
  • For cash payouts, specify `NOREQ`.
  • 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" } }, "externalcashaccount": { "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." } }, "levelofpurpose": { "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" } }, "SourceOfCash": { "type": "string", "description": "Source where funds have come from for the payment.

    Note: Both `SourceOfCash` and its sub-values are 'soft' fields. For more information, see [Soft fields](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields).", "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" } }, "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. For more information, see [ExternalCodeSets2Q2020August2020](https://www.iso20022.org/sites/default/files/2020-08/ExternalCodeSets_2Q2020_August2020_v1.xlsx).

    Usage Guidelines:
  • Do not specify `Othr.SchmeNm.Cd` if you do not specify `Othr.Id`.

    • Examples values
  • Bank account transfer: `BBAN`
  • Cash payout: `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" } }, "bic": { "type": "string", "pattern": "^([a-zA-Z0-9_-]){8,11}$", "description": "Code allocated to a receiving institution by the [ISO 9362 Registration Authority - Business identifier code (BIC)'](https://www.iso.org/standard/60390.html).

    Usage Guidelines:
  • If you specify BICFI, do not specify `ClrSysMmbId.MmbId`.
  • Use this property in conjunction with `CdtrAcct.Id.IBAN`.
  • The string must be either 8 or 11 characters long.

    Example: `BANKGB22`" }, "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](https://www.iso.org/obp/ui/#search)." }, "currency": { "type": "string", "pattern": "^[A-Z]{3,3}$", "description": "Code allocated to identify a currency." }, "phone_number": { "type": "string", "description": "A field used to identify a phone number for a contact within the payment object in E.164 format. Note: The phone_number field is a 'soft' field. For more information, see [Soft fields](https://docs.ripple.com/payments-odl/api-docs/ripplenet/resources/standard-ripplenet-payment-object/#soft-fields).", "maxLength": 15, "pattern": "^\\+?[1-9]\\d{1,14}$" }, "iban": { "type": "string", "pattern": "^([a-zA-Z0-9_-]){15,35}$", "description": "International Bank Account Number (IBAN) for the account.

    Usage Guidelines:
    If you specify `IBAN`, do not specify `Othr.Id`.
  • Example IBAN: `GB29NWBK60161331926819`." }, "fullname": { "description": "Name by which the party is known and which is usually used to identify the party.