Skip to content

Revision summary

This section describes the changes to RippleNet Payment Object v1.1.7, Supporting Information Schema.

Updates and general information

Supporting information object names

When passing supporting information within your RippleNet Payment Object to a partner, the supported object name you use is based on the Ripple Product you are using.

Ripple ProductSupporting Information Object
RippleNet v4.4.0 (and higher)
xCurrent v4.0.0 - v4.3.1
user_info
xCurrent v3.x.xadditional_info

New fields

The following fields have been added to the schema. These fields enable parties to provide further information to support compliance checks in countries that require this information.

Receivers need to add the fields to their schema. Senders need to ensure they can capture this information.

For more information, see Supporting info full JSON schema.

  • Cdtr.Id.OrgId.RelShipToDbtr and Cdtr.Id.OrgId.RelShipToCdtr fields added to specify the relationship between organizations.
    (RNPO117004)
    Benefit: Enable further information to be provided to support compliance checks in countries that require this information.
    Impact: Receivers will need to add this to their schema, and Senders will need to ensure they can capture this information.

  • Id.OrgId - Added the following soft fields to Id.OrgId to provide incorporation information and supporting documentation about Originator and Beneficiary: DtAndPlcofIncorprtn.DtofIncorprtn, DtAndPlcofIncorprtn.CtryofIncorprtn, Othr.DtOfIsse, and Othr.DtOfXpry.
    (RNPO117007)
    Benefit: Support for greater detail when processing payments for organizations.
    Impact: Receivers will need to add this to their schema, and Senders will need to ensure they can capture this information.

  • receiver_version added to the JSON schema to allow additional versioning.
    (RNPO117008)
    Benefit: Enables Receiving Members to support multiple schemas for different use cases.
    Impact: Receivers will need to add this to their schema, Senders will need to ensure they can capture and specify this information.

  • Id.OrgId - Added a new soft field Id.OrgId.Rprtv to capture the name of an organization's representative.
    (RNPO117010)
    Benefit: Support for greater detail when processing payments originating at an organization.
    Impact: Receivers will need to add this to their schema, and Senders will need to ensure they can capture this information.

Updated fields

The following fields in the schema have been updated. These updates enable parties to provide further information to support compliance checks in countries that require this information.

Receivers need update the fields in their schema. Senders need to ensure they can capture this information.

For more information, see Supporting info full JSON schema.

  • external_account_id - CASH and CASHD2D added to the list of allowed external_account_id values. (RNPO117001)
    Benefit: Enable Receivers who offer cash disbursements to be able to define the method of distribution. Impact: Receivers will need to add this to their schema, and Senders will need to ensure they can capture this information.

  • Id.OrgId.Othr.SchmeNm.Cd - USCC added to the list of Cd known values for Id.OrgId.Othr.SchmeNm.Cd to support payments into China.
    (RNOP117002)
    Benefit: Ensure support for required identification when processing payments into China.
    Impact: Receivers will need to add this to their schema, and Senders will need to ensure they can capture this information.

  • Id.PrvtId.RelShipToDbtr - Added SIBL, EXSP, CUST, and PART to the list of allowed values for Id.PrvtId.RelShipToDbtr.
    (RNPO117003)
    Benefit: Enable further information to be provided to support compliance checks in countries that require this information.
    Impact: Receivers will need to add this to their schema, and Senders will need to ensure they can capture this information.

  • externalclearningsystem - Added NGBCS to the list of supported externalclearingsystem known values to support the Nigerian Domestic Clearing System.
    (RNPO117005)
    Benefit: Enable further information to be provided to support validation in countries that require this information.
    Impact: Receivers will need to add this to their schema, and Senders will need to ensure they can capture this information.

  • Formatting improvements.
    (RNPO117006)
    Benefit: Improved clarity and accuracy of the RPO documentation.
    Impact: No impact as not used currently by RippleNet Members.

  • Updates and additions of allowed values to align with the ISO External Code List.
    (RNPO117009)
    Benefit: Ensures alignment and interoperability with the ISO 20022 standards.
    Impact: Members should ensure where required they can support these new values.
    The following lists have been updated:

    • ExternalCategoryPurpose1Code
    • ExternalLocalInstrument1Code
    • ExternalPersonIdentification1Code
    • ExternalPurpose1Code
    • ExternalServiceLevel1Code
    • ExternalCashAccountType1Code
  • The Id.OrgId.Othr and Id.PrvtId.Othr fields now accept an array of objects to support multiple identification documents to be referenced by a payment.
    (RNPO117011)
    Benefit: Enable Receivers who require multiple identification references to be able to receive this data to support compliance and risk procedures.
    Impact: Both Senders and Receivers will need to update their implementation from a single entry to multi entry where they have this requirement.

  • The RmtInf.Strd.AddtlRmtInf field now accepts an array of strings instead of a single string, allowing for multiple lines in the remittance text.
    (RNPO117012)
    Benefit: Where more than a single line of remittance text is required, this will enable Senders and Receivers to have the option to include multiple lines.
    Impact: Senders and Receivers will need to add this to their schema.

    Note: Soft fields extend the ISO 20022 specification. When they have an equivalent in ISO 20022 they would be superseded by these definitions.