RippleNet Server API (4.0.0)

The RippleNet Server API provides you the ability to develop custom applications to manage or interact with your RippleNet instance.

Check out the best practices and tutorials.

Authentication

All API operations require a bearer access token for your target environment.
Learn how to request the access token.

API environments

The RippleNet Server API creates a dynamic [domainPrefix] that consists of {tenant}.{environment}.

Note: This example uses aperture as the tenant. Your tenant ID is different.

Environment
Domain Prefix
Domain
Base URL
Test aperture.test ripplexcurrent.com https://aperture.test.ripplexcurrent.com
UAT aperture.uat ripplexcurrent.com https://aperture.uat.ripplexcurrent.com
Production aperture.prod ripplexcurrent.com https://aperture.prod.ripplexcurrent.com

Auditing

Use these operations to audit your accounts.

Operation Method Description
Get audits GET Gets an audit trail of user actions and configuration changes (to accounts, fees, and rates) on a RippleNet instance.
Get event trail for payment GET Gets an audit trail of a payment's state changes on a local RippleNet instance.

Get audits

Gets an audit trail of user actions and configuration changes (to accounts, fees, and rates) on a RippleNet instance.

SecurityBearer
Request
query Parameters
page
integer
Default: 0

The page number for paginated results. The value is zero-based, where 0 represents the first page.
Set it to 0 to get the first page of results.

size
integer [ 1 .. 100 ]
Default: 10

Number of payments to return per page.

before
string

Filters for audit events where the range_field value is before this specified time stamp (not inclusive). You can also specify after to create a time range between after and before. If before is specified, range_field must also be specified.

after
string

Filters for audit events where the range_field value is after this specified time stamp (not inclusive). You can also specify before to create a time range between after and before. If after is specified, range_field must also be specified.

range_field
string

Filters payments before/after/between created and modified timestamps (CREATED_AT, MODIFIED_AT). For example, if you specify range_field=CREATED_AT, you would specify a timestamp (in the 24-character ISO 8601 YYYY-MM-DDTHH:mm:ss.sssZ format used in payment objects) as the value for before and/or after to fetch audit events before, after, or between the specified time range(s) (not inclusive). If range_field is specified, before and/or after must also be specified.

actor
string

Filters for audit events based upon actor.

action
string

Filters for audit events based upon action.

level
string

Filters for audit events based upon audit level.

Enum: "INFO" "WARN" "ERROR"
domain
string

Filters for audit events based upon audit domain.

Enum: "USER_MANAGEMENT" "CONFIG_MANAGEMENT" "OTHER"
Responses
200

Successful response

400

Bad request.

get/audit
Request samples
Response samples
application/json
{
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "size": 0,
  • "totalElements": 0,
  • "totalPages": 0,
  • "sort": [
    • {
      • "direction": "ASC",
      • "property": "string",
      • "ignoreCase": true,
      • "nullHandling": "NULLS_FIRST",
      • "ascending": true,
      • "descending": false
      }
    ],
  • "content": [
    • {
      • "actor": "super_user_client",
      • "action": "KEY_UPDATE",
      • "eventId": "3d5d0831-762c-4e0c-980c-635b38fd9caf",
      • "message": "Added public key class PublicKeyRecord {\n publicKey: MCowBQYDK2VwAyEAb8Q2YzrbTIwrUn7u5Q6hJimp7jBFHx500MfDM4XVNJ0=\n keyIntent: SIGNING_PUBLIC_KEY\n keyType: ED_25519\n keyVersion: 1\n expiryDateTime: 2089-09-23T17:27:50.331Z\n} for RippleNet address rn.us.ny.new_york",
      • "metadata": "{\"ip\":\"0:0:0:0:0:0:0:1\",\"uri\":\"/internal/key_service/addresses/rn.us.ny.new_york/keys\"}",
      • "domain": "CONFIG_MANAGEMENT",
      • "level": "INFO",
      • "timeStamp": "2019-09-30T22:55:41.365000Z"
      }
    ]
}

Get event trail for payment

Gets an audit trail of a payment's state changes on a local RippleNet instance.

SecurityBearer
Request
path Parameters
id
required
string <uuid>

Unique identifier of a payment.

Responses
200

Payment state change event trail.

400

Bad request.

get/audit/payment/{id}
Request samples
Response samples
application/json
[
  • {
    • "featureName": "payment",
    • "eventDetail": "Updated Payment to state PREPARED",
    • "entityId": "d485f100-2af7-4e48-9ab1-3c7e28775691",
    • "messageAction": "STATE_CHANGE",
    • "createdAt": "2019-10-01T18:24:28.040000Z",
    • "messageSender": "default",
    • "messageType": "SETTLEMENT_PREPARE"
    }
]

Balances and statements

Use these operations to view balances and statements for a ledger.

Operation Method Description
Get balances GET Get balances for local and remote accounts owned by a RippleNet address.
Get ledger balances GET Get balances for ledger owned by a RippleNet address.
Get statement GET Gets a statement for an account that lists payments and transfers that impacted the account's balance during a specified date-time range.
Get statement by external account ID GET Gets a statement for an account that lists payments and transfers that impacted the account's balance during a specified date-time range.
Get ledger account statement GET Get statement for a specified Ledger Account

Get balances

Get balances for local and remote accounts owned by a RippleNet address.

SecurityBearer
Responses
200

Successfully returned balances.

400

Bad request.

get/monitor/balances
Request samples
Response samples
application/json
{
  • "local_balance": [
    • {
      • "institution": "rn.us.ca.san_francisco",
      • "institution_address": "rn.us.ca.san_francisco",
      • "currency_balances": [
        • {
          • "currency": "USD",
          • "aggregate_balance": 0,
          • "account_balances": [
            • {
              • "account_name": "trans_usd_sf",
              • "balance": -909,
              • "owner": "rn.us.ca.san_francisco",
              • "currency": "USD",
              • "minimum_allowed_balance": -1500000,
              • "maximum_allowed_balance": 1000000,
              • "low_liquidity_threshold": 1000,
              • "owner_min_allowed_balance": 0,
              • "owner_max_allowed_balance": 1000000
              }
            ]
          }
        ],
      • "pool_account_balances": [
        • {
          • "pool_account_name": "string",
          • "balance": 0,
          • "owner": "string",
          • "currency": "string",
          • "linked_accounts": [
            • "string"
            ]
          }
        ]
      }
    ],
  • "remote_balances": [
    • {
      • "institution": "rn.us.ca.san_francisco",
      • "institution_address": "rn.us.ca.san_francisco",
      • "currency_balances": [
        • {
          • "currency": "USD",
          • "aggregate_balance": 0,
          • "account_balances": [
            • {
              • "account_name": "trans_usd_sf",
              • "balance": -909,
              • "owner": "rn.us.ca.san_francisco",
              • "currency": "USD",
              • "minimum_allowed_balance": -1500000,
              • "maximum_allowed_balance": 1000000,
              • "low_liquidity_threshold": 1000,
              • "owner_min_allowed_balance": 0,
              • "owner_max_allowed_balance": 1000000
              }
            ]
          }
        ],
      • "pool_account_balances": [
        • {
          • "pool_account_name": "string",
          • "balance": 0,
          • "owner": "string",
          • "currency": "string",
          • "linked_accounts": [
            • "string"
            ]
          }
        ]
      }
    ],
  • "errors": [
    • "string"
    ]
}

Get ledger balances

Get balances for ledger owned by a RippleNet address.

SecurityBearer
Responses
200

Successfully returned balances.

400

Bad request.

get/monitor/ledger/balances
Request samples
Response samples
application/json
{
  • "local_balance": [
    • {
      • "institution": "rn.us.ca.san_francisco",
      • "institution_address": "rn.us.ca.san_francisco",
      • "currency_balances": [
        • {
          • "currency": "USD",
          • "aggregate_balance": 0,
          • "account_balances": [
            • {
              • "account_name": "trans_usd_sf",
              • "balance": -909,
              • "owner": "rn.us.ca.san_francisco",
              • "currency": "USD",
              • "minimum_allowed_balance": -1500000,
              • "maximum_allowed_balance": 1000000,
              • "low_liquidity_threshold": 1000,
              • "owner_min_allowed_balance": 0,
              • "owner_max_allowed_balance": 1000000
              }
            ]
          }
        ],
      • "pool_account_balances": [
        • {
          • "pool_account_name": "string",
          • "balance": 0,
          • "owner": "string",
          • "currency": "string",
          • "linked_accounts": [
            • "string"
            ]
          }
        ]
      }
    ],
  • "remote_balances": [
    • {
      • "institution": "rn.us.ca.san_francisco",
      • "institution_address": "rn.us.ca.san_francisco",
      • "currency_balances": [
        • {
          • "currency": "USD",
          • "aggregate_balance": 0,
          • "account_balances": [
            • {
              • "account_name": "trans_usd_sf",
              • "balance": -909,
              • "owner": "rn.us.ca.san_francisco",
              • "currency": "USD",
              • "minimum_allowed_balance": -1500000,
              • "maximum_allowed_balance": 1000000,
              • "low_liquidity_threshold": 1000,
              • "owner_min_allowed_balance": 0,
              • "owner_max_allowed_balance": 1000000
              }
            ]
          }
        ],
      • "pool_account_balances": [
        • {
          • "pool_account_name": "string",
          • "balance": 0,
          • "owner": "string",
          • "currency": "string",
          • "linked_accounts": [
            • "string"
            ]
          }
        ]
      }
    ],
  • "errors": [
    • "string"
    ]
}

Get statement

Gets a statement for an account that lists payments and transfers that impacted the account's balance during a specified date-time range.

SecurityBearer
Request
path Parameters
account_name_with_address
required
string

The RippleNet account name and address that you want to return a statement for. Use the format accountname@ripplenetaddress. For example, san_francisco@rn.us.ca.san_francisco.

query Parameters
start-date
required
string

The lower bound of the date-time range you want to return statement information for, as an ISO-8601 timestamp in UTC. For example, 2018-08-06T23:13:55.997Z.

end-date
required
string

The upper bound of the date-time range you want to return statement information for, as an ISO-8601 timestamp in UTC For example, 2018-08-06T23:15:13.218Z.

page
integer
Default: 0

The page number for paginated results. The value is zero-based, where 0 represents the first page.
Set it to 0 to get the first page of results.

size
integer [ 1 .. 100 ]
Default: 10

Number of payment and transfer objects to return per page, with a limit of 100 per page.

For example, a query with "size": "100" results in "totalPages": "43" when the query result is "totalElements": "4290".

Responses
200

Successfully returns an account statement.

400

Bad request.

404

Peer or Account not found.

get/statement/{account_name_with_address}
Request samples
Response samples
application/json
{
  • "account_name": "trans_usd_sf",
  • "start_datetime": "2018-08-06T23:13:55.997Z",
  • "end_datetime": "2020-08-06T23:13:55.997Z",
  • "generated_at": "2019-10-01T21:58:23.621Z",
  • "currency": "USD",
  • "owner": "rn.us.ca.san_francisco",
  • "opening_balance": 0,
  • "closing_balance": -909,
  • "transactions": {
    • "content": [
      • {
        • "transaction_id": "9eca588f-e89d-4629-82fa-da9c4646310f",
        • "transaction_type": "PAYMENT",
        • "transaction_state": "COMPLETED",
        • "balance_change": -15,
        • "balance_result": -909,
        • "created_at": "2019-10-01T21:28:28.354Z",
        • "end_to_end_id": "91ecb6bd-4dd8-4b53-a900-72b79f3064e4",
        • "internal_id": "8afd8e99-4ad4-4f4e-9bb7-018ad8c3a89c",
        • "venue_id": "nz7RpAujYgnQtjEM",
        • "transaction_hash": "DB0AFC09E0A94FC1D11F8CBABA48A184E27094F8DD32FCBC46F316E98011E2A6",
        • "returns_payment_with_id": "a69b322f-faa4-4531-bcff-897e5839c130",
        • "returned_by_payment_with_id": "c929a87b-81b8-4878-b21c-1aeaa4fe9276",
        • "balance_change_created_at": "2019-10-01T21:28:28.354Z",
        • "sender_address": "rn.us.ca.san_francisco",
        • "receiver_address": "rn.mx.mexico"
        }
      ],
    • "total_elements": 1,
    • "sort": "string",
    • "first": true,
    • "last": true,
    • "number": 0,
    • "numberOfElements": 1,
    • "size": 10,
    • "totalPages": 1
    }
}

Get statement by external account ID

Gets a statement for an account that lists payments and transfers that impacted the account's balance during a specified date-time range.

SecurityBearer
Request
path Parameters
external_account_id
required
string

The external account ID associated with the account.

query Parameters
start-date
required
string

The lower bound of the date-time range you want to return statement information for, as an ISO-8601 timestamp in UTC. For example, 2018-08-06T23:13:55.997Z.

end-date
required
string

The upper bound of the date-time range you want to return statement information for, as an ISO-8601 timestamp in UTC. For example, 2018-08-06T23:15:13.218Z.

page
integer
Default: 0

The page number for paginated results. The value is zero-based, where 0 represents the first page.
Set it to 0 to get the first page of results.

size
integer [ 1 .. 100 ]
Default: 10

Number of payment and transfer objects to return per page.

Responses
200

Successfully returns an account statement.

400

Bad request.

404

Peer or Account not found.

get/statement/external_account_id/{external_account_id}
Request samples
Response samples
application/json
{
  • "account_name": "trans_usd_sf",
  • "start_datetime": "2018-08-06T23:13:55.997Z",
  • "end_datetime": "2020-08-06T23:13:55.997Z",
  • "generated_at": "2019-10-01T21:58:23.621Z",
  • "currency": "USD",
  • "owner": "rn.us.ca.san_francisco",
  • "opening_balance": 0,
  • "closing_balance": -909,
  • "transactions": {
    • "content": [
      • {
        • "transaction_id": "9eca588f-e89d-4629-82fa-da9c4646310f",
        • "transaction_type": "PAYMENT",
        • "transaction_state": "COMPLETED",
        • "balance_change": -15,
        • "balance_result": -909,
        • "created_at": "2019-10-01T21:28:28.354Z",
        • "end_to_end_id": "91ecb6bd-4dd8-4b53-a900-72b79f3064e4",
        • "internal_id": "8afd8e99-4ad4-4f4e-9bb7-018ad8c3a89c",
        • "venue_id": "nz7RpAujYgnQtjEM",
        • "transaction_hash": "DB0AFC09E0A94FC1D11F8CBABA48A184E27094F8DD32FCBC46F316E98011E2A6",
        • "returns_payment_with_id": "a69b322f-faa4-4531-bcff-897e5839c130",
        • "returned_by_payment_with_id": "c929a87b-81b8-4878-b21c-1aeaa4fe9276",
        • "balance_change_created_at": "2019-10-01T21:28:28.354Z",
        • "sender_address": "rn.us.ca.san_francisco",
        • "receiver_address": "rn.mx.mexico"
        }
      ],
    • "total_elements": 1,
    • "sort": "string",
    • "first": true,
    • "last": true,
    • "number": 0,
    • "numberOfElements": 1,
    • "size": 10,
    • "totalPages": 1
    }
}

Get ledger account statement

Get statement for a specified Ledger Account

SecurityBearer
Request
path Parameters
account_name_with_address
required
string

The RippleNet account name and address that you want to return a statement for. Use the format accountname@ripplenetaddress. For example, san_francisco@rn.us.ca.san_francisco.

query Parameters
start-date
required
string

The lower bound of the date-time range you want to return statement information for, as an ISO-8601 timestamp in UTC. For example, 2018-08-06T23:13:55.997Z.

end-date
required
string

The upper bound of the date-time range you want to return statement information for, as an ISO-8601 timestamp in UTC For example, 2018-08-06T23:15:13.218Z.

page
integer
Default: 0

The page number for paginated results. The value is zero-based, where 0 represents the first page.
Set it to 0 to get the first page of results.

size
integer [ 1 .. 100 ]
Default: 10

Number of payment and transfer objects to return per page.

Responses
200

Successfully returned statement for a specified ledger account.

400

Bad request.

404

Peer or Account not found.

get/statement/ledger/{account_name_with_address}
Request samples
Response samples
application/json
{
  • "account_name": "trans_usd_sf",
  • "start_datetime": "2018-08-06T23:13:55.997Z",
  • "end_datetime": "2020-08-06T23:13:55.997Z",
  • "generated_at": "2019-10-01T21:58:23.621Z",
  • "currency": "USD",
  • "owner": "rn.us.ca.san_francisco",
  • "opening_balance": 0,
  • "closing_balance": -909,
  • "transactions": {
    • "content": [
      • {
        • "transaction_id": "9eca588f-e89d-4629-82fa-da9c4646310f",
        • "transaction_type": "PAYMENT",
        • "transaction_state": "COMPLETED",
        • "balance_change": -15,
        • "balance_result": -909,
        • "created_at": "2019-10-01T21:28:28.354Z",
        • "end_to_end_id": "91ecb6bd-4dd8-4b53-a900-72b79f3064e4",
        • "internal_id": "8afd8e99-4ad4-4f4e-9bb7-018ad8c3a89c",
        • "venue_id": "nz7RpAujYgnQtjEM",
        • "transaction_hash": "DB0AFC09E0A94FC1D11F8CBABA48A184E27094F8DD32FCBC46F316E98011E2A6",
        • "returns_payment_with_id": "a69b322f-faa4-4531-bcff-897e5839c130",
        • "returned_by_payment_with_id": "c929a87b-81b8-4878-b21c-1aeaa4fe9276",
        • "balance_change_created_at": "2019-10-01T21:28:28.354Z",
        • "sender_address": "rn.us.ca.san_francisco",
        • "receiver_address": "rn.mx.mexico"
        }
      ],
    • "total_elements": 1,
    • "sort": "string",
    • "first": true,
    • "last": true,
    • "number": 0,
    • "numberOfElements": 1,
    • "size": 10,
    • "totalPages": 1
    }
}

Beneficiary confirmation

Use these operations to perform beneficiary confirmations.

Operation Method Description
Get account lookup by status GET Get Account Lookup entities by status and other filters.
Initiate account lookup POST Creates an Account Lookup request to validate a beneficiary's account details before sending a payment.
Complete account lookup POST Posts an Account Lookup response to validate a beneficiary's account details before payment.
Get account lookup by ID GET Gets an Account Lookup entity for its account_lookup_id value.

Get account lookup by status

Get Account Lookup entities by status and other filters. Status defaults to REQUESTED.

SecurityBearer
Request
query Parameters
page
integer
Default: 0

The page number for paginated results. The value is zero-based, where 0 represents the first page.
Set it to 0 to get the first page of results.

size
integer [ 1 .. 100 ]
Default: 10

Number of objects to return per page

account_lookup_status
Array of strings (AccountLookupStatus)
Default: ["REQUESTED"]

Account Lookup status

Items Enum: "REQUESTED" "PROCESSED" "FAILED" "EXPIRED"
start-date
string

The lower bound of the date-time range you want to return account lookup for, as an ISO-8601 timestamp in UTC. For example, 2018-08-06T23:13:55.997Z.

end-date
string

The upper bound of the date-time range you want to return statement information for, as an ISO-8601 timestamp in UTC For example, 2018-08-06T23:15:13.218Z.

sort_field
string
Default: "LAST_MODIFIED_DATE"

Attribute for how to sort the results

Enum: "CREATED_DATE" "LAST_MODIFIED_DATE"
sort_direction
string
Default: "ASC"

Direction of sorted results.

Enum: "ASC" "DESC"
Responses
200

Successfully returned response for Account Lookup

400

Bad request problem

404

Account Lookup Not Found

500

Server Error - No valid network path to receiver. Account Lookup is not supported by a participant in the network path.

get/account_lookups
Request samples
Response samples
application/json
{
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "size": 0,
  • "totalElements": 0,
  • "totalPages": 0,
  • "sort": [
    • {
      • "direction": "ASC",
      • "property": "string",
      • "ignoreCase": true,
      • "nullHandling": "NULLS_FIRST",
      • "ascending": true,
      • "descending": false
      }
    ],
  • "content": [
    • {
      • "account_lookup_id": "efc26a87-de06-4aef-8217-4566df3c9f14",
      • "account_lookup_status": "REQUESTED",
      • "first_name": "string",
      • "middle_name": "string",
      • "last_name": "string",
      • "org_name": "string",
      • "country_code": "string",
      • "account_currency": "string",
      • "account_id": "string",
      • "account_id_type": "AIIN",
      • "result_code": "string",
      • "result_status": "PASS",
      • "result_description": "string",
      • "redacted_first_name": "string",
      • "redacted_middle_name": "string",
      • "redacted_last_name": "string",
      • "redacted_org_name": "string",
      • "redacted_country_code": "string",
      • "redacted_account_id": "string",
      • "redacted_account_id_type": "AIIN",
      • "redacted_account_currency": "string",
      • "clearing_system_code": "string",
      • "branch_code": "string"
      }
    ]
}

Initiate account lookup

Creates an Account Lookup request to validate a beneficiary's account details before sending a payment. Account lookups are not part of the payment flow and can be made at any time in the payment process.

SecurityBearer
Request
Request Body schema: application/json
account_currency
string

The 3 character currency code for the account as per ISO-4217 standards

clearing_system_code
string <= 50 characters

Clearing system code

destination_address
required
string

RippleNet address of the receiver.

first_name
string <= 40 characters

First name of the beneficiary.

middle_name
string <= 40 characters

Middle name of the beneficiary.

last_name
string <= 40 characters

Last name of the beneficiary.

org_name
string <= 140 characters

Name of the organization.

country_code
required
string <= 2 characters

Country of the beneficiary. Alpha-2 Code format per ISO 3166-1.

account_id
required
string <= 40 characters

Identifier for the Account, e.g account number.

account_id_type
required
string

Account ID type. Possible values are

  • AIIN - (default) Account Issue Identification Number
  • BBAN - Basic Bank Account Number
  • CARD - PAN of the card identifying the account
  • CUID - CHIPS Universal Identifier
  • UPIC - Universal Payment Identification Code
  • EMail - Email Address
  • MSISDN - Mobile Subscriber Integrated Service Digital Network (i.e., phone number)
  • DMST - Domestic
  • Other - Other identifier (e.g., PayID)
Enum: "AIIN" "BBAN" "CARD" "CUID" "UPIC" "EMAIL" "MSISDN" "DMST" "OTHER"
Responses
200

Successfully returned Account Lookup response.

400

Bad Request Problem.

500

Server Error - No valid network path to receiver. Account Lookup is not supported by a participant in the network path.

post/account_lookups/request
Request samples
application/json
{
  • "account_currency": "string",
  • "clearing_system_code": "string",
  • "destination_address": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "org_name": "string",
  • "country_code": "st",
  • "account_id": "string",
  • "account_id_type": "AIIN"
}
Response samples
application/json
{
  • "account_lookup_id": "efc26a87-de06-4aef-8217-4566df3c9f14",
  • "account_lookup_status": "REQUESTED",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "org_name": "string",
  • "country_code": "string",
  • "account_currency": "string",
  • "account_id": "string",
  • "account_id_type": "AIIN",
  • "result_code": "string",
  • "result_status": "PASS",
  • "result_description": "string",
  • "redacted_first_name": "string",
  • "redacted_middle_name": "string",
  • "redacted_last_name": "string",
  • "redacted_org_name": "string",
  • "redacted_country_code": "string",
  • "redacted_account_id": "string",
  • "redacted_account_id_type": "AIIN",
  • "redacted_account_currency": "string",
  • "clearing_system_code": "string",
  • "branch_code": "string"
}

Complete account lookup

Posts an Account Lookup response to validate a beneficiary's account details before payment.

SecurityBearer
Request
Request Body schema: application/json
account_lookup_id
required
string <uuid>

UUID that links Account Lookup request and response.

result_code
required
string^RNCB\d{4}

Result code of the Account Lookup response. Possible values are

  • RNCB0000 - Pass- Name and Identifier are correct and linked
  • RNCB0001 - Fail- Name and Identifier not found
  • RNCB0002 - Fail- Name and Identifier do not match
result_status
required
string

Result status of Account Lookup response

Enum: "PASS" "FAIL"
result_description
required
string

Result description of Account Lookup response

redacted_first_name
string <= 40 characters

First name of the beneficiary.

redacted_middle_name
string <= 40 characters

Middle name of the beneficiary.

redacted_last_name
string <= 40 characters

Last name of the beneficiary.

redacted_org_name
string <= 140 characters

Name of the organization.

redacted_country_code
string

Country of the beneficiary. Alpha-2 Code format per ISO 3166-1.

redacted_account_id
string <= 40 characters

Identifier for the Account, e.g account number.

redacted_account_id_type
string

Account ID type, redacted by the receiver. Possible values are

  • AIIN - (default) Account Issue Identification Number
  • BBAN - Basic Bank Account Number
  • CARD - PAN of the card identifying the account
  • CUID - CHIPS Universal Identifier
  • UPIC - Universal Payment Identification Code
  • EMail - Email Address
  • MSISDN - Mobile Subscriber Integrated Service Digital Network (i.e., phone number)
  • DMST - Domestic
  • Other - Other identifier (e.g., PayID)
Enum: "AIIN" "BBAN" "CARD" "CUID" "UPIC" "EMAIL" "MSISDN" "DMST" "OTHER"
redacted_clearing_system_code
string

Clearing system code

redacted_branch_code
string

The Branch code (e.g., routing code) that the receiver has on their system.

redacted_account_currency
string

The 3 character currency code for the account as per ISO-4217 standards

Responses
200

Successfully returns acknowledgement for Account Lookup response.

400

Bad request problem

404

Account Lookup Not Found

500

Server Error - No valid network path to receiver. Account Lookup is not supported by a participant in the network path.

post/account_lookups/response
Request samples
application/json
{
  • "account_lookup_id": "efc26a87-de06-4aef-8217-4566df3c9f14",
  • "result_code": "string",
  • "result_status": "PASS",
  • "result_description": "string",
  • "redacted_first_name": "string",
  • "redacted_middle_name": "string",
  • "redacted_last_name": "string",
  • "redacted_org_name": "string",
  • "redacted_country_code": "string",
  • "redacted_account_id": "string",
  • "redacted_account_id_type": "AIIN",
  • "redacted_clearing_system_code": "string",
  • "redacted_branch_code": "string",
  • "redacted_account_currency": "string"
}
Response samples
application/json
{
  • "account_lookup_id": "efc26a87-de06-4aef-8217-4566df3c9f14",
  • "account_lookup_status": "REQUESTED",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "org_name": "string",
  • "country_code": "string",
  • "account_currency": "string",
  • "account_id": "string",
  • "account_id_type": "AIIN",
  • "result_code": "string",
  • "result_status": "PASS",
  • "result_description": "string",
  • "redacted_first_name": "string",
  • "redacted_middle_name": "string",
  • "redacted_last_name": "string",
  • "redacted_org_name": "string",
  • "redacted_country_code": "string",
  • "redacted_account_id": "string",
  • "redacted_account_id_type": "AIIN",
  • "redacted_account_currency": "string",
  • "clearing_system_code": "string",
  • "branch_code": "string"
}

Get account lookup by ID

Gets an Account Lookup entity for its account_lookup_id value.

SecurityBearer
Request
path Parameters
account_lookup_id
required
string <uuid>

AccountLookupId

Responses
200

Successfully returned Account Lookup response.

400

Bad request problem

404

Account Lookup Not Found

500

Server Error - No valid network path to receiver. Account Lookup is not supported by a participant in the network path.

get/account_lookups/{account_lookup_id}
Request samples
Response samples
application/json
{
  • "account_lookup_id": "efc26a87-de06-4aef-8217-4566df3c9f14",
  • "account_lookup_status": "REQUESTED",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "org_name": "string",
  • "country_code": "string",
  • "account_currency": "string",
  • "account_id": "string",
  • "account_id_type": "AIIN",
  • "result_code": "string",
  • "result_status": "PASS",
  • "result_description": "string",
  • "redacted_first_name": "string",
  • "redacted_middle_name": "string",
  • "redacted_last_name": "string",
  • "redacted_org_name": "string",
  • "redacted_country_code": "string",
  • "redacted_account_id": "string",
  • "redacted_account_id_type": "AIIN",
  • "redacted_account_currency": "string",
  • "clearing_system_code": "string",
  • "branch_code": "string"
}

Diagnostics

Use these operations to view RippleNet Server health.

Operation Method Description
Check health GET Gets the health status of the xCurrent server.
Check heartbeat GET Gets the health status of the xCurrent server's peers.

Check health

Gets the health status of the xCurrent server.

SecurityBearer
Responses
200

Successful response.

400

Bad request.

get/health
Request samples
Response samples
application/json
{
  • "healthy": true,
  • "services": [
    • {
      • "service": "database",
      • "healthy": true,
      • "detail": "Message queue unreachable."
      }
    ],
  • "detail": "Failed to perform health check"
}

Check heartbeat

Gets the health status of the xCurrent server's peers. This request requires authorization. The timeout for this operation is 5 seconds.

SecurityBearer
Responses
200

Successful response.

400

Bad request.

get/heartbeat
Request samples
Response samples
application/json
{
  • "time_checked": "2019-10-01",
  • "xcurrent_node": "rn.us.ny.new_york",
  • "ripplenet_node": "rn.us.ny.new_york",
  • "peer_heartbeat_results": {
    • "property1": "HEALTHY",
    • "property2": "HEALTHY"
    },
  • "errors": [
    • "string"
    ]
}

Exchange transfers

Use these operations to manage exchange transfers.

Operation Method Description
Get exchange transfers GET List all exchange transfers.
Execute exchange transfer POST Execute an exchange transfer to move funds from one of your accounts in one currency, to another one of your accounts in another currency.
Get exchange transfer quote POST Requests a quote for an exchange transfer.
Complete exchange transfer POST Updates the status of an exchange transfer to COMPLETED. Make this request once the exchange transfer has been made on both the ledger and on internal systems.
Get exchange transfer by ID GET Gets an exchange transfer by ID.

Get exchange transfers

Gets all exchange transfers.

SecurityBearer
Request
query Parameters
page
integer
Default: 0

The page number for paginated results. The value is zero-based, where 0 represents the first page.
Set it to 0 to get the first page of results.

size
integer [ 1 .. 100 ]
Default: 20

Number of objects to return per page.

Responses
200

Successfully retrieved exchange transfers.

400

Bad request.

get/exchange_transfers
Request samples
Response samples
application/json
{
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "size": 0,
  • "totalElements": 0,
  • "totalPages": 0,
  • "sort": [
    • {
      • "direction": "ASC",
      • "property": "string",
      • "ignoreCase": true,
      • "nullHandling": "NULLS_FIRST",
      • "ascending": true,
      • "descending": false
      }
    ],
  • "content": [
    • {
      • "exchange_transfer_id": "e3b20ba4-28ed-4752-990d-e67887bb331e",
      • "state": "EXECUTED",
      • "type": "INDICATIVE",
      • "sender_address": "sf@rn.us.ca.san_francisco",
      • "receiver_address": "sf_gbp@rn.us.ca.san_francisco",
      • "source_amount": 1,
      • "destination_amount": 355,
      • "source_currency": "USD",
      • "destination_currency": "GBP",
      • "fx_transfer_rate": {
        • "rate": 0.89,
        • "base_currency": "USD",
        • "counter_currency": "GBP",
        • "rate_type": "BUY"
        },
      • "end_to_end_id": "string",
      • "internal_id": "string",
      • "user_info": [
        • {
          • "node_address": "rn.us.ny.new_york",
          • "state": "EXECUTED",
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z"
          }
        ]
      }
    ]
}

Execute exchange transfer

Execute an exchange transfer to move funds from one of your accounts in one currency (USD, for example) to another one of your accounts in another currency (EUR, for example) at an exchange rate set by your peer who maintains both of your accounts on their ledger. An exchange transfer enables you to fund a foreign currency account from your domestic currency account in bulk.

Before you make this request, you may want to use the Quote Exchange Transfer request to see a quote for the exchange transfer you want to make.

SecurityBearer
Request
Request Body schema: application/json
sender_address
required
string

RippleNet account name and address of the sender, in the format accountname@ripplenetaddress. For example, new_york@rn.us.ny.new_york.

receiver_address
required
string

RippleNet account name and address of the receiver, in the format accountname@ripplenetaddress. For example, new_york@rn.us.ny.new_york.

amount
required
number >= 0

Amount transferred, expressed in the curency of the account indicated by the amount_type value.

amount_type
required
string

Amount type used for the exchange transfer.

To indicate that the amount is expressed in the currency of the account provided by the sender_address value, set to SENDER_AMOUNT.

To indicate that the amount is expressed in the currency of the account provided by the receiver_address value, set to RECEIVER_AMOUNT.

Enum: "SENDER_AMOUNT" "RECEIVER_AMOUNT"
end_to_end_id
string <= 128 characters

ID set by the sender that is persisted on all fiat node instances that participated in the transfer.

internal_id
string <= 128 characters

Internal ID that the sender can optionally specify. Only visible to the sender. Only the sending fiat node instance stores this ID.

user_info
object

Provide one or more arbitrary key/value pairs.

Responses
200

Successfully executed exchange transfer.

400

Bad request.

post/exchange_transfers/execute
Request samples
application/json
{
  • "sender_address": "alias_usd_lon@rn.eur.uk.london",
  • "receiver_address": "conct_gbp_lon@rn.eur.uk.london",
  • "amount": 100,
  • "amount_type": "SENDER_AMOUNT",
  • "end_to_end_id": 378910,
  • "internal_id": 1987,
  • "user_info": { }
}
Response samples
application/json
{
  • "exchange_transfer_id": "e3b20ba4-28ed-4752-990d-e67887bb331e",
  • "state": "EXECUTED",
  • "type": "INDICATIVE",
  • "sender_address": "sf@rn.us.ca.san_francisco",
  • "receiver_address": "sf_gbp@rn.us.ca.san_francisco",
  • "source_amount": 1,
  • "destination_amount": 355,
  • "source_currency": "USD",
  • "destination_currency": "GBP",
  • "fx_transfer_rate": {
    • "rate": 0.89,
    • "base_currency": "USD",
    • "counter_currency": "GBP",
    • "rate_type": "BUY"
    },
  • "end_to_end_id": "string",
  • "internal_id": "string",
  • "user_info": [
    • {
      • "node_address": "rn.us.ny.new_york",
      • "state": "EXECUTED",
      • "json": { },
      • "created_at": "2019-08-24T14:15:22Z"
      }
    ]
}

Get exchange transfer quote

Requests a quote for an exchange transfer.

SecurityBearer
Request
Request Body schema: application/json
sender_address
required
string

RippleNet account name and address of the sender, in the format accountname@ripplenetaddress. For example, new_york@rn.us.ny.new_york.

receiver_address
required
string

RippleNet account name and address of the receiver, in the format accountname@ripplenetaddress. For example, new_york@rn.us.ny.new_york.

amount
required
number >= 0

Amount transferred, expressed in the curency of the account indicated by the amount_type value.

amount_type
required
string

Amount type of the exchange transfer.

To indicate that the amount is expressed in the currency of the account provided by the sender_address value, set to SENDER_AMOUNT.

To indicate that the amount is expressed in the currency of the account provided by the receiver_address value, set to RECEIVER_AMOUNT.

Enum: "SENDER_AMOUNT" "RECEIVER_AMOUNT"
Responses
200

Successfully quoted exchange transfer.

400

Bad request.

post/exchange_transfers/quote
Request samples
application/json
{
  • "sender_address": "alias_usd_lon@rn.eur.uk.london",
  • "receiver_address": "conct_gbp_lon@rn.eur.uk.london",
  • "amount": 100,
  • "amount_type": "SENDER_AMOUNT"
}
Response samples
application/json
{
  • "type": "INDICATIVE",
  • "sender_address": "alias_usd_lon@rn.eur.uk.london",
  • "receiver_address": "conct_gbp_lon@rn.eur.uk.london",
  • "source_amount": 100,
  • "destination_amount": 89,
  • "source_currency": "USD",
  • "destination_currency": "GBP",
  • "fx_transfer_rate": {
    • "rate": 0.89,
    • "base_currency": "USD",
    • "counter_currency": "GBP",
    • "rate_type": "BUY"
    }
}

Complete exchange transfer

Updates the status of an exchange transfer to COMPLETED. Make this request once the exchange transfer has been made on both the ledger and on internal systems.

SecurityBearer
Request
path Parameters
id
required
string <uuid>

Unique identifier of the exchange transfer to complete.

Responses
200

Successfully completed exchange transfer.

404

Exchange transfer not found.

post/exchange_transfers/{id}/complete
Request samples
Response samples
application/json
{
  • "exchange_transfer_id": "e3b20ba4-28ed-4752-990d-e67887bb331e",
  • "state": "EXECUTED",
  • "type": "INDICATIVE",
  • "sender_address": "sf@rn.us.ca.san_francisco",
  • "receiver_address": "sf_gbp@rn.us.ca.san_francisco",
  • "source_amount": 1,
  • "destination_amount": 355,
  • "source_currency": "USD",
  • "destination_currency": "GBP",
  • "fx_transfer_rate": {
    • "rate": 0.89,
    • "base_currency": "USD",
    • "counter_currency": "GBP",
    • "rate_type": "BUY"
    },
  • "end_to_end_id": "string",
  • "internal_id": "string",
  • "user_info": [
    • {
      • "node_address": "rn.us.ny.new_york",
      • "state": "EXECUTED",
      • "json": { },
      • "created_at": "2019-08-24T14:15:22Z"
      }
    ]
}

Get exchange transfer by ID

Gets an exchange transfer by ID.

SecurityBearer
Request
path Parameters
id
required
string <uuid>

Unique identifier of the exchange transfer you want to retrieve.

Responses
200

Successfully retrieved exchange transfer.

404

Exchange transfer not found.

get/exchange_transfers/{id}
Request samples
Response samples
application/json
{
  • "exchange_transfer_id": "e3b20ba4-28ed-4752-990d-e67887bb331e",
  • "state": "EXECUTED",
  • "type": "INDICATIVE",
  • "sender_address": "sf@rn.us.ca.san_francisco",
  • "receiver_address": "sf_gbp@rn.us.ca.san_francisco",
  • "source_amount": 1,
  • "destination_amount": 355,
  • "source_currency": "USD",
  • "destination_currency": "GBP",
  • "fx_transfer_rate": {
    • "rate": 0.89,
    • "base_currency": "USD",
    • "counter_currency": "GBP",
    • "rate_type": "BUY"
    },
  • "end_to_end_id": "string",
  • "internal_id": "string",
  • "user_info": [
    • {
      • "node_address": "rn.us.ny.new_york",
      • "state": "EXECUTED",
      • "json": { },
      • "created_at": "2019-08-24T14:15:22Z"
      }
    ]
}

Fees

Use these operations to configure fees.

Operation Method Description
Get fees GET List all fees.
Create fee POST Creates a fee.
Get fee by ID GET Gets a fee by ID.
Update fee PUT Updates an existing fee.
Delete fee DELETE Deletes a fee. Once deleted, a fee cannot be accessed.

Get fees

Gets a list of fees.

SecurityBearer
Request
query Parameters
page
integer
Default: 0

Number of pages returned. Returns one page of results when set to 0.

size
integer
Default: 10

Number of objects returned per page.

Responses
200

Successfully returns list of fees.

400

Bad request.

get/config/fees
Request samples
Response samples
application/json
{
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "size": 0,
  • "totalElements": 0,
  • "totalPages": 0,
  • "sort": [
    • {
      • "direction": "ASC",
      • "property": "string",
      • "ignoreCase": true,
      • "nullHandling": "NULLS_FIRST",
      • "ascending": true,
      • "descending": false
      }
    ],
  • "content": [
    • {
      • "value": 2,
      • "currency_code": "USD",
      • "role_type": "SENDING",
      • "payment_type": "REGULAR",
      • "node_type": "INITIAL",
      • "fee_type": "FLAT_RATE",
      • "partner_name": "rn.us.ca.san_francisco",
      • "account_name": "conct_usd_sf",
      • "upper_limit": 1000,
      • "lower_limit": 0,
      • "feeId": "7740f31c-ca03-4414-b491-b285aef71eb1",
      • "payout_method": "LOCAL_RAILS",
      • "fee_category": "BENEFICIARY_BANK_CHARGE",
      • "fee_description": "string"
      }
    ]
}

Create fee

Creates a fee.

SecurityBearer
Request
Request Body schema: application/json
value
required
number

Value of the fee to apply.

Set the value of this parameter according to the fee type you are using:

fee_type Corresponding value to use
PERCENTAGE value must be >0 and <100.
FLAT_RATE value can be negative.

Note: The final amount of the fee is applied either as a percentage or a flat rate depending on the value you specify for the fee_type parameter.

currency_code
required
string

Currency the fee is applied in. Ripple recommends using ISO-4217 currency codes, although no formal constraint is enforced.

role_type
required
string

Role of the party to which the fee applies.

Enum: Description
SENDING

Charge the originator of the payment.

RECEIVING

Charge the beneficiary of the payment.

INSTITUTION_SENDING

Charge the financial institution sending the payment.

INSTITUTION_RECEIVING

Charge the financial institution receiving the payment.

payment_type
required
string

Type of payment to which the fee applies.

Enum: Description
REGULAR

Apply the fee to a regular payment.

RETURN

Apply the fee to a return payment.

node_type
required
string

Fiat instance to which the fee applies.

Enum: Description
INITIAL

Apply the fee to the first fiat instance in the payment chain.

INTERMEDIATE

Apply the fee to each fiat instance in the payment chain that is not the first or last.

TERMINAL

Apply the fee to the last fiat instance in the payment chain.

fee_type
required
string

Type of fee to apply. This is used with fee value to calculate the fee.

Enum: Description
PERCENTAGE

Apply the fee value as a percentage.

FLAT_RATE

Apply the fee value as a flat rate.

partner_name
string

Owner of the account involved in the payment, in RippleNet Address format. For example, rn.us.ca.san_francisco.

account_name
string

Account to apply the fee to. Specify the account name. For example, conct_usd_sf. If specified, you must also specify a partner_name value.

upper_limit
number

Maximum amount for the range of a slab-based fee. If specified, you must also specify a lower_limit value.

lower_limit
number

Minimum amount for the range of a slab-based fee. If specified, you must also specify an upper_limit value.

payout_method
string

The payout method by which the receiving institution delivers the funds to the end customer.

fee_category
string
Default: "NONE"

Category that describes the purpose of the fee.

Enum: Description
NONE

None

OVERSEAS_DELIVERY_CHARGES

Overseas delivery charges.

BENEFICIARY_BANK_CHARGE

Charge from beneficiary bank.

PROCESSING_HANDLING_CHARGE

Processing and handling charge.

LOCAL_GOVERNMENT_CHARGE

Local government charge.

OTHER

Other charges.

fee_description
string

Optional free-form description for the fee.

Responses
200

Successfully created fee.

400

Bad Request.

post/config/fees
Request samples
application/json
{
  • "value": 0.025,
  • "currency_code": "USD",
  • "role_type": "SENDING",
  • "payment_type": "REGULAR",
  • "node_type": "INITIAL",
  • "fee_type": "FLAT_RATE",
  • "partner_name": "rn.us.ca.san_francisco",
  • "account_name": "conct_usd_sf",
  • "upper_limit": 1000,
  • "lower_limit": 0,
  • "payout_method": "LOCAL_RAILS",
  • "fee_category": "BENEFICIARY_BANK_CHARGE",
  • "fee_description": "string"
}
Response samples
application/json
{
  • "value": 2,
  • "currency_code": "USD",
  • "role_type": "SENDING",
  • "payment_type": "REGULAR",
  • "node_type": "INITIAL",
  • "fee_type": "FLAT_RATE",
  • "partner_name": "rn.us.ca.san_francisco",
  • "account_name": "conct_usd_sf",
  • "upper_limit": 1000,
  • "lower_limit": 0,
  • "feeId": "7740f31c-ca03-4414-b491-b285aef71eb1",
  • "payout_method": "LOCAL_RAILS",
  • "fee_category": "BENEFICIARY_BANK_CHARGE",
  • "fee_description": "string"
}

Get fee by ID

Gets a fee by ID.

SecurityBearer
Request
path Parameters
id
required
string <uuid>

Provide the feeId of the fee you want to retrieve.

Responses
200

Successfully retrieved fee.

404

Fee not found.

get/config/fees/{id}
Request samples
Response samples
application/json
{
  • "value": 2,
  • "currency_code": "USD",
  • "role_type": "SENDING",
  • "payment_type": "REGULAR",
  • "node_type": "INITIAL",
  • "fee_type": "FLAT_RATE",
  • "partner_name": "rn.us.ca.san_francisco",
  • "account_name": "conct_usd_sf",
  • "upper_limit": 1000,
  • "lower_limit": 0,
  • "feeId": "7740f31c-ca03-4414-b491-b285aef71eb1",
  • "payout_method": "LOCAL_RAILS",
  • "fee_category": "BENEFICIARY_BANK_CHARGE",
  • "fee_description": "string"
}

Update fee

Updates an existing fee.

SecurityBearer
Request
path Parameters
id
required
string <uuid>

Provide the feeId of the fee you want to update.

Request Body schema: application/json
value
required
number

Value of the fee to apply.

Set the value of this parameter according to the fee type you are using:

fee_type Corresponding value to use
PERCENTAGE value must be >0 and <100.
FLAT_RATE value can be negative.

Note: The final amount of the fee is applied either as a percentage or a flat rate depending on the value you specify for the fee_type parameter.

currency_code
required
string

Currency the fee is applied in. Ripple recommends using ISO-4217 currency codes, although no formal constraint is enforced.

role_type
required
string

Role of the party to which the fee applies.

Enum: Description
SENDING

Charge the originator of the payment.

RECEIVING

Charge the beneficiary of the payment.

INSTITUTION_SENDING

Charge the financial institution sending the payment.

INSTITUTION_RECEIVING

Charge the financial institution receiving the payment.

payment_type
required
string

Type of payment to which the fee applies.

Enum: Description
REGULAR

Apply the fee to a regular payment.

RETURN

Apply the fee to a return payment.

node_type
required
string

Fiat instance to which the fee applies.

Enum: Description
INITIAL

Apply the fee to the first fiat instance in the payment chain.

INTERMEDIATE

Apply the fee to each fiat instance in the payment chain that is not the first or last.

TERMINAL

Apply the fee to the last fiat instance in the payment chain.

fee_type
required
string

Type of fee to apply. This is used with fee value to calculate the fee.

Enum: Description
PERCENTAGE

Apply the fee value as a percentage.

FLAT_RATE

Apply the fee value as a flat rate.

partner_name
string

Owner of the account involved in the payment, in RippleNet Address format. For example, rn.us.ca.san_francisco.

account_name
string

Account to apply the fee to. Specify the account name. For example, conct_usd_sf. If specified, you must also specify a partner_name value.

upper_limit
number

Maximum amount for the range of a slab-based fee. If specified, you must also specify a lower_limit value.

lower_limit
number

Minimum amount for the range of a slab-based fee. If specified, you must also specify an upper_limit value.

payout_method
string

The payout method by which the receiving institution delivers the funds to the end customer.

fee_category
string
Default: "NONE"

Category that describes the purpose of the fee.

Enum: Description
NONE

None

OVERSEAS_DELIVERY_CHARGES

Overseas delivery charges.

BENEFICIARY_BANK_CHARGE

Charge from beneficiary bank.

PROCESSING_HANDLING_CHARGE

Processing and handling charge.

LOCAL_GOVERNMENT_CHARGE

Local government charge.

OTHER

Other charges.

fee_description
string

Optional free-form description for the fee.

Responses
200

Successfully updated fee.

400

Bad Request.

put/config/fees/{id}
Request samples
application/json
{
  • "value": 0.025,
  • "currency_code": "USD",
  • "role_type": "SENDING",
  • "payment_type": "REGULAR",
  • "node_type": "INITIAL",
  • "fee_type": "FLAT_RATE",
  • "partner_name": "rn.us.ca.san_francisco",
  • "account_name": "conct_usd_sf",
  • "upper_limit": 1000,
  • "lower_limit": 0,
  • "payout_method": "LOCAL_RAILS",
  • "fee_category": "BENEFICIARY_BANK_CHARGE",
  • "fee_description": "string"
}
Response samples
application/json
{
  • "value": 2,
  • "currency_code": "USD",
  • "role_type": "SENDING",
  • "payment_type": "REGULAR",
  • "node_type": "INITIAL",
  • "fee_type": "FLAT_RATE",
  • "partner_name": "rn.us.ca.san_francisco",
  • "account_name": "conct_usd_sf",
  • "upper_limit": 1000,
  • "lower_limit": 0,
  • "feeId": "7740f31c-ca03-4414-b491-b285aef71eb1",
  • "payout_method": "LOCAL_RAILS",
  • "fee_category": "BENEFICIARY_BANK_CHARGE",
  • "fee_description": "string"
}

Delete fee

Deletes a fee. Once deleted, a fee cannot be accessed.

SecurityBearer
Request
path Parameters
id
required
string <uuid>

Provide the feeId of the fee you want to delete.

Responses
200

Successfully deleted fee.

400

Bad request.

delete/config/fees/{id}
Request samples
Response samples
application/json
{}

Non-orchestration payments

Get payments

Retrieves all payments in an instance of xCurrent that meet the criteria defined by the query parameters. You can use the query parameters to filter payments. The default parameters are sort_field : MODIFIED_AT , sort_direction : DESC , page : 0 , size : 10

SecurityBearer
Request
query Parameters
page
integer
Default: 0

The page number for paginated results. The value is zero-based, where 0 represents the first page.
Set it to 0 to get the first page of results.

size
integer [ 1 .. 100 ]
Default: 10

Number of payments to return per page.

sending_host
string

Optional parameter for filtering with sendingHost value.

receiving_host
string

Optional parameter for filtering with receivingHost value.

sending_account
string

Optional parameter for filtering with sendingAccount value.

receiving_account
string

Optional parameter for filtering with receivingAccount value.

sending_currency
string

Optional parameter for filtering with sendingCurrency value.

receiving_currency
string

Optional parameter for filtering with receivingCurrency value.

payment_id
string <uuid>
Deprecated

Optional parameter for filtering with paymentId value. This parameter is deprecated. Please use payment_ids instead

payment_type
string

Filters for payments based on the type of payment. Valid types are REGULAR, RETURN.

internal_id
string

Optional parameter for filtering with internalId.

sender_end_to_end_id
string

Optional parameter for filtering with senderEndToEndId.

connector_role
string

Filters for payments based on the role of the responding connector. Valid roles are SENDING, INTERMEDIARY, RECEIVING, and INTERNAL. The INTERNAL role is meant for payments between RippleNet Cloud and RippleNet where the sender and receiver accounts are on the same RippleNet instance. Use role with state to find payments waiting on action from you as the sending or receiving (or internal) connector.

state
string

Deprecated, should use states parameter. Returns payments in the specified state. The following options are valid: ACCEPTED, COMPLETED, EXECUTED, FAILED, LOCKED, LOCK_DECLINED, PREPARED, RETURNED, and SETTLEMENT_DECLINED

states
Array of strings

Returns payments in the specified states. The following options are valid: ACCEPTED, COMPLETED, EXECUTED, FAILED, LOCKED, LOCK_DECLINED, PREPARED, RETURNED, and SETTLEMENT_DECLINED

before
string

Filters for payments where the payments range_field column value is before this specified time stamp (not inclusive). You can also specify after to create a time range between after and before. If before is specified, range_field must also be specified.

after
string

Filters for payments where the payments range_field column value is after this specified time stamp (not inclusive). You can also specify before to create a time range between after and before. If after is specified, range_field must also be specified.

range_field
string

Designates the column name of the payments database table that is used for filtering payments before/after/between time stamps. The following options are valid: CREATED_AT, MODIFIED_AT, ACCEPTED_AT, LOCKED_AT, EXECUTED_AT, COMPLETED_AT, RETURNED_AT and EXPIRES_AT. For example, if you specify range_field=MODIFIED_AT, you would specify a time stamp (in the 24 character ISO 8601 YYYY-MM-DDTHH:mm:ss.sssZ format used in payment objects) as the value for before and/or after to fetch payments before, after, or between the specified time range(s) (not inclusive). If range_field is specified, before and/or after must also be specified.

amount_range_field
string

Designates the column name of the payments database table that is used for filtering payments greater/less/between amounts. For example, if you specify amount_range_field=SENDING_AMOUNT, you would specify an amount as the value for greater and/or less to fetch payments greater, less, or between the specified amounts (inclusive). If amount_range_field is specified, minAmount and/or maxAmount must also be specified.

Enum: "SENDING_AMOUNT" "RECEIVING_AMOUNT"
min_amount
number >= 0

Optional parameter for filtering with min sending/receiving amount.

max_amount
number >= 0

Optional parameter for filtering with max sending/receiving amount.

with_labels
Array of strings

Returns payments with the specified labels.

If you apply with_labels with multiple labels, the response returns payments with at least one of the specified labels.

For example, the query,

?with_labels=string1,string2

returns payments with either "string1" OR "string2".

without_labels
Array of strings

Returns payments that do not have any of the specified labels.

If you apply without_labels with multiple labels, the response returns payments that do not have any of the specified labels.

For example, the query,

?without_labels=string3,string4

returns payments that are not labeled with either "string3" OR "string4".

If you apply both with_labels and without_labels parameters, the response returns payments that have at least one of the specified with_labels strings but omits payments that also have any of the the without_labels strings.

For example, the query,

?with_labels=string1&without_labels=string3

returns payments with "string1" but not payments with "string3".

sort_field
string
Default: "MODIFIED_AT"

Sorts results according to the specified field. Valid options are PAYMENT_ID, EXPIRES_AT, MODIFIED_AT and CREATED_AT.

sort_direction
string
Default: "DESC"

Sorts result according to the specified direction. Valid options are ASC, DESC.

load_additional_details
boolean
Default: true

This parameter can be used to exclude additional info being returned for each payment object. Additional info which will be excluded if the flag set to false include user_info, ripplenet_info, execution_results and internal_info.labels

payment_ids
Array of strings <uuid>

List of paymentIds to search for

Responses
200

Successful response

400

Bad request.

get/payments
Request samples
Response samples
{
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "size": 0,
  • "totalElements": 0,
  • "totalPages": 0,
  • "sort": [
    • {
      • "direction": "ASC",
      • "property": "string",
      • "ignoreCase": true,
      • "nullHandling": "NULLS_FIRST",
      • "ascending": true,
      • "descending": false
      }
    ],
  • "content": [
    • {
      • "payment_id": "d485f100-2af7-4e48-9ab1-3c7e28775691",
      • "contract_hash": "ccb23bd87f13cc13b9d616a9723f76e112aeac8628b2082e0f8bf3b8c670b103",
      • "payment_state": "COMPLETED",
      • "modified_at": "2019-10-01T18:25:47.347Z",
      • "contract": {
        • "sender_end_to_end_id": "string",
        • "created_at": "2019-10-01T18:18:13.665Z",
        • "expires_at": "2019-10-01T18:55:22.824Z",
        • "quote": {
          • "quote_id": "2a547e56-4aac-4375-86a8-8b3e7014801d",
          • "created_at": "2020-01-29T20:59:44.925Z",
          • "expires_at": "2020-01-29T21:29:44.925Z",
          • "type": "SENDER_AMOUNT",
          • "price_guarantee": "FIRM",
          • "sender_address": "sf@rn.us.ca.san_francisco",
          • "receiver_address": "sf_gbp@rn.us.ca.san_francisco",
          • "amount": 1,
          • "currency_code": "USD",
          • "currency_code_filter": "EUR",
          • "service_type": "string",
          • "quote_elements": [
            • {
              • "quote_element_id": "259189e7-cb14-42e7-99ef-375f3285e356",
              • "quote_element_type": "EXCHANGE",
              • "quote_element_order": 1,
              • "sender_address": "sf@rn.us.ca.san_francisco",
              • "receiver_address": "sf_gbp@rn.us.ca.san_francisco",
              • "sending_amount": 1,
              • "receiving_amount": 355,
              • "sending_fee": 0,
              • "receiving_fee": 0,
              • "sending_currency_code": "USD",
              • "receiving_currency_code": "GBP",
              • "fx_rate": {
                • "rate": null,
                • "base_currency_code": null,
                • "counter_currency_code": null,
                • "type": null
                },
              • "transfer_currency_code": "string"
              }
            ],
          • "liquidity_warning": "string",
          • "payment_method": "LOCAL_RAILS",
          • "payment_method_fields": "{\"category_id\":\"bank\",\"required_originator_fields\":[{\"field_name\":\"sender_address\",\"field_label\":\"Sender address\"}]}",
          • "payout_method_info": {
            • "payout_method_name": "Cash Payout",
            • "payout_method_category": "BOOK_TRANSFER",
            • "description": "local rails",
            • "estimated_time_to_credit": "3 days"
            }
          },
        • "fee_info": {
          • "nodes": {
            • "property1": [
              • {
                • "fee_value": null,
                • "fee_currency": null,
                • "category": null,
                • "fee_description": null
                }
              ],
            • "property2": [
              • {
                • "fee_value": null,
                • "fee_currency": null,
                • "category": null,
                • "fee_description": null
                }
              ]
            },
          • "total_fees": [
            • {
              • "total_fee": 0,
              • "fee_currency": "string"
              }
            ]
          }
        },
      • "ripplenet_info": [
        • {
          • "node_address": "rn.us.ny.new_york",
          • "settlement_declined": [
            • {
              • "info": "L001",
              • "created_at": "2018-04-06T20:33:35Z"
              }
            ]
          }
        ],
      • "execution_condition": "PrefixSha256Condition{subtypes=[ED25519-SHA-256], type=PREFIX-SHA-256, fingerprint=sfGGHCrkyaMsLQNB62w_4zarlPChHKm47JkXVQbs1z0, cost=132360}",
      • "crypto_transaction_id": "4e05da26-7872-4a1f-b9b7-db7604757c37",
      • "validator": "rn.us.ca.san_francisco",
      • "payment_type": "REGULAR",
      • "returns_payment_with_id": "a69b322f-faa4-4531-bcff-897e5839c130",
      • "returned_by_payment_with_id": "c929a87b-81b8-4878-b21c-1aeaa4fe9276",
      • "execution_results": [
        • {
          • "execution_result_id": "06f6d4e2-3523-4d17-92fd-53192a06207f",
          • "execution_timestamp": "2019-10-01T18:24:29.867Z",
          • "execution_result_type": "TRANSFER",
          • "execution_result_order": 1,
          • "sender_address": "trans_usd_sf@rn.us.ca.san_francisco",
          • "receiver_address": "conct_usd_sf@rn.us.ca.san_francisco",
          • "sending_amount": 498,
          • "receiving_amount": 498,
          • "sending_fee": 2,
          • "receiving_fee": 0,
          • "sending_currency_code": "USD",
          • "receiving_currency_code": "GBP",
          • "fx_rate": {
            • "rate": 3.25,
            • "base_currency_code": "string",
            • "counter_currency_code": "string",
            • "type": "string"
            },
          • "transfer_currency_code": "string",
          • "intermediary_delta": 0.2,
          • "incentive_type": "firm",
          • "incentive_value": 0.2,
          • "transaction_hash": 5.5467794184785867e+76,
          • "venue_id": "nz7RpAujYgnQtjEM",
          • "fiat_adjusted_value": 0.02,
          • "odl_payment_id": "string"
          }
        ],
      • "liquidation_execution_results": [
        • {
          • "execution_result_id": "06f6d4e2-3523-4d17-92fd-53192a06207f",
          • "execution_timestamp": "2019-10-01T18:24:29.867Z",
          • "execution_result_type": "TRANSFER",
          • "execution_result_order": 1,
          • "sender_address": "trans_usd_sf@rn.us.ca.san_francisco",
          • "receiver_address": "conct_usd_sf@rn.us.ca.san_francisco",
          • "sending_amount": 498,
          • "receiving_amount": 498,
          • "sending_fee": 2,
          • "receiving_fee": 0,
          • "sending_currency_code": "USD",
          • "receiving_currency_code": "GBP",
          • "fx_rate": {
            • "rate": 3.25,
            • "base_currency_code": "string",
            • "counter_currency_code": "string",
            • "type": "string"
            },
          • "transfer_currency_code": "string",
          • "intermediary_delta": 0.2,
          • "incentive_type": "firm",
          • "incentive_value": 0.2,
          • "transaction_hash": 5.5467794184785867e+76,
          • "venue_id": "nz7RpAujYgnQtjEM",
          • "fiat_adjusted_value": 0.02,
          • "odl_payment_id": "string"
          }
        ],
      • "liquidation_details": {
        • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        • "status": "string",
        • "failure_reason": "string",
        • "failure_count": 0
        },
      • "push_forward_execution_results": [
        • {
          • "execution_result_id": "06f6d4e2-3523-4d17-92fd-53192a06207f",
          • "execution_timestamp": "2019-10-01T18:24:29.867Z",
          • "execution_result_type": "TRANSFER",
          • "execution_result_order": 1,
          • "sender_address": "trans_usd_sf@rn.us.ca.san_francisco",
          • "receiver_address": "conct_usd_sf@rn.us.ca.san_francisco",
          • "sending_amount": 498,
          • "receiving_amount": 498,
          • "sending_fee": 2,
          • "receiving_fee": 0,
          • "sending_currency_code": "USD",
          • "receiving_currency_code": "GBP",
          • "fx_rate": {
            • "rate": 3.25,
            • "base_currency_code": "string",
            • "counter_currency_code": "string",
            • "type": "string"
            },
          • "transfer_currency_code": "string",
          • "intermediary_delta": 0.2,
          • "incentive_type": "firm",
          • "incentive_value": 0.2,
          • "transaction_hash": 5.5467794184785867e+76,
          • "venue_id": "nz7RpAujYgnQtjEM",
          • "fiat_adjusted_value": 0.02,
          • "odl_payment_id": "string"
          }
        ],
      • "accepted_at": "2019-10-01T18:25:47.347Z",
      • "locked_at": "2019-10-01T18:25:47.347Z",
      • "executed_at": "2019-10-01T18:25:47.347Z",
      • "completed_at": "2019-10-01T18:25:47.347Z",
      • "returned_at": "2019-10-01T18:25:47.347Z",
      • "internal_info": {
        • "connector_role": "RECEIVING",
        • "labels": [
          • {
            • "label": "string"
            }
          ],
        • "internal_id": "string"
        },
      • "user_info": [
        • {
          • "node_address": "rn.us.ca.san_francisco",
          • "accepted": [
            • {
              • "json": { },
              • "created_at": "2019-08-24T14:15:22Z",
              • "subState": "EXECUTING"
              }
            ],
          • "locked": [
            • {
              • "json": { },
              • "created_at": "2019-08-24T14:15:22Z",
              • "subState": "EXECUTING"
              }
            ],
          • "lock_declined": [
            • {
              • "json": { },
              • "created_at": "2019-08-24T14:15:22Z",
              • "subState": "EXECUTING"
              }
            ],
          • "retry_accept": [
            • {
              • "json": { },
              • "created_at": "2019-08-24T14:15:22Z",
              • "subState": "EXECUTING"
              }
            ],
          • "retry_settlement": [
            • {
              • "json": { },
              • "created_at": "2019-08-24T14:15:22Z",
              • "subState": "EXECUTING"
              }
            ],
          • "settlement": [
            • {
              • "json": { },
              • "created_at": "2019-08-24T14:15:22Z",
              • "subState": "EXECUTING"
              }
            ],
          • "settlement_declined": [
            • {
              • "json": { },
              • "created_at": "2019-08-24T14:15:22Z",
              • "subState": "EXECUTING"
              }
            ],
          • "failed": [
            • {
              • "json": { },
              • "created_at": "2019-08-24T14:15:22Z",
              • "subState": "EXECUTING"
              }
            ],
          • "executed": [
            • {
              • "json": { },
              • "created_at": "2019-08-24T14:15:22Z",
              • "subState": "EXECUTING"
              }
            ],
          • "completed": [
            • {
              • "json": { },
              • "created_at": "2019-08-24T14:15:22Z",
              • "subState": "EXECUTING"
              }
            ],
          • "forwarded": [
            • {
              • "json": { },
              • "created_at": "2019-08-24T14:15:22Z",
              • "subState": "EXECUTING"
              }
            ],
          • "returned": [
            • {
              • "json": { },
              • "created_at": "2019-08-24T14:15:22Z",
              • "subState": "EXECUTING"
              }
            ]
          }
        ]
      }
    ]
}

Get payment by payment ID

Gets a payment by ID.

SecurityBearer
Request
path Parameters
payment_id
required
string <uuid>

Unique identifier of the payment you want to retrieve.

Responses
200

Successfully retrieved payment.

400

Bad request.

404

Payment not found.

get/payments/{payment_id}
Request samples
Response samples
application/json
{
  • "payment_id": "d485f100-2af7-4e48-9ab1-3c7e28775691",
  • "contract_hash": "ccb23bd87f13cc13b9d616a9723f76e112aeac8628b2082e0f8bf3b8c670b103",
  • "payment_state": "COMPLETED",
  • "modified_at": "2019-10-01T18:25:47.347Z",
  • "contract": {
    • "sender_end_to_end_id": "string",
    • "created_at": "2019-10-01T18:18:13.665Z",
    • "expires_at": "2019-10-01T18:55:22.824Z",
    • "quote": {
      • "quote_id": "2a547e56-4aac-4375-86a8-8b3e7014801d",
      • "created_at": "2020-01-29T20:59:44.925Z",
      • "expires_at": "2020-01-29T21:29:44.925Z",
      • "type": "SENDER_AMOUNT",
      • "price_guarantee": "FIRM",
      • "sender_address": "sf@rn.us.ca.san_francisco",
      • "receiver_address": "sf_gbp@rn.us.ca.san_francisco",
      • "amount": 1,
      • "currency_code": "USD",
      • "currency_code_filter": "EUR",
      • "service_type": "string",
      • "quote_elements": [
        • {
          • "quote_element_id": "259189e7-cb14-42e7-99ef-375f3285e356",
          • "quote_element_type": "EXCHANGE",
          • "quote_element_order": 1,
          • "sender_address": "sf@rn.us.ca.san_francisco",
          • "receiver_address": "sf_gbp@rn.us.ca.san_francisco",
          • "sending_amount": 1,
          • "receiving_amount": 355,
          • "sending_fee": 0,
          • "receiving_fee": 0,
          • "sending_currency_code": "USD",
          • "receiving_currency_code": "GBP",
          • "fx_rate": {
            • "rate": 3.25,
            • "base_currency_code": "string",
            • "counter_currency_code": "string",
            • "type": "string"
            },
          • "transfer_currency_code": "string"
          }
        ],
      • "liquidity_warning": "string",
      • "payment_method": "LOCAL_RAILS",
      • "payment_method_fields": "{\"category_id\":\"bank\",\"required_originator_fields\":[{\"field_name\":\"sender_address\",\"field_label\":\"Sender address\"}]}",
      • "payout_method_info": {
        • "payout_method_name": "Cash Payout",
        • "payout_method_category": "BOOK_TRANSFER",
        • "description": "local rails",
        • "estimated_time_to_credit": "3 days"
        }
      },
    • "fee_info": {
      • "nodes": {
        • "property1": [
          • {
            • "fee_value": 0,
            • "fee_currency": "string",
            • "category": "string",
            • "fee_description": "string"
            }
          ],
        • "property2": [
          • {
            • "fee_value": 0,
            • "fee_currency": "string",
            • "category": "string",
            • "fee_description": "string"
            }
          ]
        },
      • "total_fees": [
        • {
          • "total_fee": 0,
          • "fee_currency": "string"
          }
        ]
      }
    },
  • "ripplenet_info": [
    • {
      • "node_address": "rn.us.ny.new_york",
      • "settlement_declined": [
        • {
          • "info": "L001",
          • "created_at": "2018-04-06T20:33:35Z"
          }
        ]
      }
    ],
  • "execution_condition": "PrefixSha256Condition{subtypes=[ED25519-SHA-256], type=PREFIX-SHA-256, fingerprint=sfGGHCrkyaMsLQNB62w_4zarlPChHKm47JkXVQbs1z0, cost=132360}",
  • "crypto_transaction_id": "4e05da26-7872-4a1f-b9b7-db7604757c37",
  • "validator": "rn.us.ca.san_francisco",
  • "payment_type": "REGULAR",
  • "returns_payment_with_id": "a69b322f-faa4-4531-bcff-897e5839c130",
  • "returned_by_payment_with_id": "c929a87b-81b8-4878-b21c-1aeaa4fe9276",
  • "execution_results": [
    • {
      • "execution_result_id": "06f6d4e2-3523-4d17-92fd-53192a06207f",
      • "execution_timestamp": "2019-10-01T18:24:29.867Z",
      • "execution_result_type": "TRANSFER",
      • "execution_result_order": 1,
      • "sender_address": "trans_usd_sf@rn.us.ca.san_francisco",
      • "receiver_address": "conct_usd_sf@rn.us.ca.san_francisco",
      • "sending_amount": 498,
      • "receiving_amount": 498,
      • "sending_fee": 2,
      • "receiving_fee": 0,
      • "sending_currency_code": "USD",
      • "receiving_currency_code": "GBP",
      • "fx_rate": {
        • "rate": 3.25,
        • "base_currency_code": "string",
        • "counter_currency_code": "string",
        • "type": "string"
        },
      • "transfer_currency_code": "string",
      • "intermediary_delta": 0.2,
      • "incentive_type": "firm",
      • "incentive_value": 0.2,
      • "transaction_hash": 5.5467794184785867e+76,
      • "venue_id": "nz7RpAujYgnQtjEM",
      • "fiat_adjusted_value": 0.02,
      • "odl_payment_id": "string"
      }
    ],
  • "liquidation_execution_results": [
    • {
      • "execution_result_id": "06f6d4e2-3523-4d17-92fd-53192a06207f",
      • "execution_timestamp": "2019-10-01T18:24:29.867Z",
      • "execution_result_type": "TRANSFER",
      • "execution_result_order": 1,
      • "sender_address": "trans_usd_sf@rn.us.ca.san_francisco",
      • "receiver_address": "conct_usd_sf@rn.us.ca.san_francisco",
      • "sending_amount": 498,
      • "receiving_amount": 498,
      • "sending_fee": 2,
      • "receiving_fee": 0,
      • "sending_currency_code": "USD",
      • "receiving_currency_code": "GBP",
      • "fx_rate": {
        • "rate": 3.25,
        • "base_currency_code": "string",
        • "counter_currency_code": "string",
        • "type": "string"
        },
      • "transfer_currency_code": "string",
      • "intermediary_delta": 0.2,
      • "incentive_type": "firm",
      • "incentive_value": 0.2,
      • "transaction_hash": 5.5467794184785867e+76,
      • "venue_id": "nz7RpAujYgnQtjEM",
      • "fiat_adjusted_value": 0.02,
      • "odl_payment_id": "string"
      }
    ],
  • "liquidation_details": {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "status": "string",
    • "failure_reason": "string",
    • "failure_count": 0
    },
  • "push_forward_execution_results": [
    • {
      • "execution_result_id": "06f6d4e2-3523-4d17-92fd-53192a06207f",
      • "execution_timestamp": "2019-10-01T18:24:29.867Z",
      • "execution_result_type": "TRANSFER",
      • "execution_result_order": 1,
      • "sender_address": "trans_usd_sf@rn.us.ca.san_francisco",
      • "receiver_address": "conct_usd_sf@rn.us.ca.san_francisco",
      • "sending_amount": 498,
      • "receiving_amount": 498,
      • "sending_fee": 2,
      • "receiving_fee": 0,
      • "sending_currency_code": "USD",
      • "receiving_currency_code": "GBP",
      • "fx_rate": {
        • "rate": 3.25,
        • "base_currency_code": "string",
        • "counter_currency_code": "string",
        • "type": "string"
        },
      • "transfer_currency_code": "string",
      • "intermediary_delta": 0.2,
      • "incentive_type": "firm",
      • "incentive_value": 0.2,
      • "transaction_hash": 5.5467794184785867e+76,
      • "venue_id": "nz7RpAujYgnQtjEM",
      • "fiat_adjusted_value": 0.02,
      • "odl_payment_id": "string"
      }
    ],
  • "accepted_at": "2019-10-01T18:25:47.347Z",
  • "locked_at": "2019-10-01T18:25:47.347Z",
  • "executed_at": "2019-10-01T18:25:47.347Z",
  • "completed_at": "2019-10-01T18:25:47.347Z",
  • "returned_at": "2019-10-01T18:25:47.347Z",
  • "internal_info": {
    • "connector_role": "RECEIVING",
    • "labels": [
      • {
        • "label": "string"
        }
      ],
    • "internal_id": "string"
    },
  • "user_info": [
    • {
      • "node_address": "rn.us.ca.san_francisco",
      • "accepted": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "locked": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "lock_declined": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "retry_accept": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "retry_settlement": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "settlement": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "settlement_declined": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "failed": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "executed": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "completed": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "forwarded": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "returned": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ]
      }
    ]
}

Lock payment

Locks a payment. The beneficiary and all intermediary institutions agree to proceed with the payment by making successful Lock Payment requests. When the payment is still in a partially LOCKED state, the beneficiary and all intermediary institutions who have not locked, can reject lock payment or fail payment.

Once fully LOCKED, the originating institution can either fail payment or Settle payment. If the originating institution sends a Settle payment request, one of three things will happen:

  • Successful payments move to the PREPARED state.
  • Payments with insufficient liquidity automatically move into state SETTLEMENT_DECLINED, or
  • Payments that are not settled before the crypto_transaction_id expires move to the FAILED state.

Note: Currently, when making a Create quote to return payment to a RippleNet Cloud account on a RippleNet ledger, the RippleNet user must lock and complete the payment. This means that the RippleNet user takes all action on the return: Get and Accept Quote, Lock, Settle, and Complete payment.

SecurityBearer
Request
path Parameters
payment_id
required
string <uuid>

Unique identifier of the payment to lock.

Request Body schema: application/json
internal_id
string <= 128 characters

ID that intermediaries and the receiver can set when locking a payment. The ID is viewable only by the node that set it.

user_info
object

Provide one or more arbitrary key/value pairs.

Caution: Ripple recommends that you always include this object, even when empty, to ensure that the RippleNet Payment Object includes the created_at timestamp, which records when the payment was locked. To add an empty object, include: {"user_info":[]}

Responses
200

Successfully locked payment.

400

Bad request.

404

Payment not found.

post/payments/{payment_id}/lock
Request samples
application/json
{
  • "internal_id": "string",
  • "user_info": { }
}
Response samples
application/json
{
  • "payment_id": "d485f100-2af7-4e48-9ab1-3c7e28775691",
  • "contract_hash": "ccb23bd87f13cc13b9d616a9723f76e112aeac8628b2082e0f8bf3b8c670b103",
  • "payment_state": "COMPLETED",
  • "modified_at": "2019-10-01T18:25:47.347Z",
  • "contract": {
    • "sender_end_to_end_id": "string",
    • "created_at": "2019-10-01T18:18:13.665Z",
    • "expires_at": "2019-10-01T18:55:22.824Z",
    • "quote": {
      • "quote_id": "2a547e56-4aac-4375-86a8-8b3e7014801d",
      • "created_at": "2020-01-29T20:59:44.925Z",
      • "expires_at": "2020-01-29T21:29:44.925Z",
      • "type": "SENDER_AMOUNT",
      • "price_guarantee": "FIRM",
      • "sender_address": "sf@rn.us.ca.san_francisco",
      • "receiver_address": "sf_gbp@rn.us.ca.san_francisco",
      • "amount": 1,
      • "currency_code": "USD",
      • "currency_code_filter": "EUR",
      • "service_type": "string",
      • "quote_elements": [
        • {
          • "quote_element_id": "259189e7-cb14-42e7-99ef-375f3285e356",
          • "quote_element_type": "EXCHANGE",
          • "quote_element_order": 1,
          • "sender_address": "sf@rn.us.ca.san_francisco",
          • "receiver_address": "sf_gbp@rn.us.ca.san_francisco",
          • "sending_amount": 1,
          • "receiving_amount": 355,
          • "sending_fee": 0,
          • "receiving_fee": 0,
          • "sending_currency_code": "USD",
          • "receiving_currency_code": "GBP",
          • "fx_rate": {
            • "rate": 3.25,
            • "base_currency_code": "string",
            • "counter_currency_code": "string",
            • "type": "string"
            },
          • "transfer_currency_code": "string"
          }
        ],
      • "liquidity_warning": "string",
      • "payment_method": "LOCAL_RAILS",
      • "payment_method_fields": "{\"category_id\":\"bank\",\"required_originator_fields\":[{\"field_name\":\"sender_address\",\"field_label\":\"Sender address\"}]}",
      • "payout_method_info": {
        • "payout_method_name": "Cash Payout",
        • "payout_method_category": "BOOK_TRANSFER",
        • "description": "local rails",
        • "estimated_time_to_credit": "3 days"
        }
      },
    • "fee_info": {
      • "nodes": {
        • "property1": [
          • {
            • "fee_value": 0,
            • "fee_currency": "string",
            • "category": "string",
            • "fee_description": "string"
            }
          ],
        • "property2": [
          • {
            • "fee_value": 0,
            • "fee_currency": "string",
            • "category": "string",
            • "fee_description": "string"
            }
          ]
        },
      • "total_fees": [
        • {
          • "total_fee": 0,
          • "fee_currency": "string"
          }
        ]
      }
    },
  • "ripplenet_info": [
    • {
      • "node_address": "rn.us.ny.new_york",
      • "settlement_declined": [
        • {
          • "info": "L001",
          • "created_at": "2018-04-06T20:33:35Z"
          }
        ]
      }
    ],
  • "execution_condition": "PrefixSha256Condition{subtypes=[ED25519-SHA-256], type=PREFIX-SHA-256, fingerprint=sfGGHCrkyaMsLQNB62w_4zarlPChHKm47JkXVQbs1z0, cost=132360}",
  • "crypto_transaction_id": "4e05da26-7872-4a1f-b9b7-db7604757c37",
  • "validator": "rn.us.ca.san_francisco",
  • "payment_type": "REGULAR",
  • "returns_payment_with_id": "a69b322f-faa4-4531-bcff-897e5839c130",
  • "returned_by_payment_with_id": "c929a87b-81b8-4878-b21c-1aeaa4fe9276",
  • "execution_results": [
    • {
      • "execution_result_id": "06f6d4e2-3523-4d17-92fd-53192a06207f",
      • "execution_timestamp": "2019-10-01T18:24:29.867Z",
      • "execution_result_type": "TRANSFER",
      • "execution_result_order": 1,
      • "sender_address": "trans_usd_sf@rn.us.ca.san_francisco",
      • "receiver_address": "conct_usd_sf@rn.us.ca.san_francisco",
      • "sending_amount": 498,
      • "receiving_amount": 498,
      • "sending_fee": 2,
      • "receiving_fee": 0,
      • "sending_currency_code": "USD",
      • "receiving_currency_code": "GBP",
      • "fx_rate": {
        • "rate": 3.25,
        • "base_currency_code": "string",
        • "counter_currency_code": "string",
        • "type": "string"
        },
      • "transfer_currency_code": "string",
      • "intermediary_delta": 0.2,
      • "incentive_type": "firm",
      • "incentive_value": 0.2,
      • "transaction_hash": 5.5467794184785867e+76,
      • "venue_id": "nz7RpAujYgnQtjEM",
      • "fiat_adjusted_value": 0.02,
      • "odl_payment_id": "string"
      }
    ],
  • "liquidation_execution_results": [
    • {
      • "execution_result_id": "06f6d4e2-3523-4d17-92fd-53192a06207f",
      • "execution_timestamp": "2019-10-01T18:24:29.867Z",
      • "execution_result_type": "TRANSFER",
      • "execution_result_order": 1,
      • "sender_address": "trans_usd_sf@rn.us.ca.san_francisco",
      • "receiver_address": "conct_usd_sf@rn.us.ca.san_francisco",
      • "sending_amount": 498,
      • "receiving_amount": 498,
      • "sending_fee": 2,
      • "receiving_fee": 0,
      • "sending_currency_code": "USD",
      • "receiving_currency_code": "GBP",
      • "fx_rate": {
        • "rate": 3.25,
        • "base_currency_code": "string",
        • "counter_currency_code": "string",
        • "type": "string"
        },
      • "transfer_currency_code": "string",
      • "intermediary_delta": 0.2,
      • "incentive_type": "firm",
      • "incentive_value": 0.2,
      • "transaction_hash": 5.5467794184785867e+76,
      • "venue_id": "nz7RpAujYgnQtjEM",
      • "fiat_adjusted_value": 0.02,
      • "odl_payment_id": "string"
      }
    ],
  • "liquidation_details": {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "status": "string",
    • "failure_reason": "string",
    • "failure_count": 0
    },
  • "push_forward_execution_results": [
    • {
      • "execution_result_id": "06f6d4e2-3523-4d17-92fd-53192a06207f",
      • "execution_timestamp": "2019-10-01T18:24:29.867Z",
      • "execution_result_type": "TRANSFER",
      • "execution_result_order": 1,
      • "sender_address": "trans_usd_sf@rn.us.ca.san_francisco",
      • "receiver_address": "conct_usd_sf@rn.us.ca.san_francisco",
      • "sending_amount": 498,
      • "receiving_amount": 498,
      • "sending_fee": 2,
      • "receiving_fee": 0,
      • "sending_currency_code": "USD",
      • "receiving_currency_code": "GBP",
      • "fx_rate": {
        • "rate": 3.25,
        • "base_currency_code": "string",
        • "counter_currency_code": "string",
        • "type": "string"
        },
      • "transfer_currency_code": "string",
      • "intermediary_delta": 0.2,
      • "incentive_type": "firm",
      • "incentive_value": 0.2,
      • "transaction_hash": 5.5467794184785867e+76,
      • "venue_id": "nz7RpAujYgnQtjEM",
      • "fiat_adjusted_value": 0.02,
      • "odl_payment_id": "string"
      }
    ],
  • "accepted_at": "2019-10-01T18:25:47.347Z",
  • "locked_at": "2019-10-01T18:25:47.347Z",
  • "executed_at": "2019-10-01T18:25:47.347Z",
  • "completed_at": "2019-10-01T18:25:47.347Z",
  • "returned_at": "2019-10-01T18:25:47.347Z",
  • "internal_info": {
    • "connector_role": "RECEIVING",
    • "labels": [
      • {
        • "label": "string"
        }
      ],
    • "internal_id": "string"
    },
  • "user_info": [
    • {
      • "node_address": "rn.us.ca.san_francisco",
      • "accepted": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "locked": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "lock_declined": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "retry_accept": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "retry_settlement": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "settlement": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "settlement_declined": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "failed": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "executed": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "completed": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "forwarded": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "returned": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ]
      }
    ]
}

Reject lock payment

Rejects a payment from being locked.

This temporarily stops the payment and keeps it in a recoverable state so that user_info can be corrected. If the payment is incorrect for reasons outside of the user_info object, use Fail payment.

After a payment has been created by an Accept quote request, the beneficiary or an intermediary can choose to reject the payment, rather than Lock payment, with corrections to user_info in the reasons array. A rejected payment moves the payment state to LOCK_DECLINED from which it can be recovered by the originating institution with a Retry accept payment request.

If any one institution in the payment chain is configured to auto-fail, the payment automatically fails when the payment is rejected, moving to the FAILED state rather than the LOCK_DECLINED state.

SecurityBearer
Request
path Parameters
payment_id
required
string <uuid>

Unique identifier of a payment to reject a lock request.

Request Body schema: application/json
reasons
required
object

Provide one or more arbitrary key/value pairs.

Responses
200

Successfully rejected the request to lock a payment.

400

Bad request.

404

Payment not found.

post/payments/{payment_id}/reject
Request samples
application/json
{
  • "reasons": {
    • "type": "RECEIVER_DATA_VALIDATION",
    • "code": "AC03",
    • "reason": "Creditor account number invalid or missing"
    }
}
Response samples
application/json
{
  • "payment_id": "d485f100-2af7-4e48-9ab1-3c7e28775691",
  • "contract_hash": "ccb23bd87f13cc13b9d616a9723f76e112aeac8628b2082e0f8bf3b8c670b103",
  • "payment_state": "COMPLETED",
  • "modified_at": "2019-10-01T18:25:47.347Z",
  • "contract": {
    • "sender_end_to_end_id": "string",
    • "created_at": "2019-10-01T18:18:13.665Z",
    • "expires_at": "2019-10-01T18:55:22.824Z",
    • "quote": {
      • "quote_id": "2a547e56-4aac-4375-86a8-8b3e7014801d",
      • "created_at": "2020-01-29T20:59:44.925Z",
      • "expires_at": "2020-01-29T21:29:44.925Z",
      • "type": "SENDER_AMOUNT",
      • "price_guarantee": "FIRM",
      • "sender_address": "sf@rn.us.ca.san_francisco",
      • "receiver_address": "sf_gbp@rn.us.ca.san_francisco",
      • "amount": 1,
      • "currency_code": "USD",
      • "currency_code_filter": "EUR",
      • "service_type": "string",
      • "quote_elements": [
        • {
          • "quote_element_id": "259189e7-cb14-42e7-99ef-375f3285e356",
          • "quote_element_type": "EXCHANGE",
          • "quote_element_order": 1,
          • "sender_address": "sf@rn.us.ca.san_francisco",
          • "receiver_address": "sf_gbp@rn.us.ca.san_francisco",
          • "sending_amount": 1,
          • "receiving_amount": 355,
          • "sending_fee": 0,
          • "receiving_fee": 0,
          • "sending_currency_code": "USD",
          • "receiving_currency_code": "GBP",
          • "fx_rate": {
            • "rate": 3.25,
            • "base_currency_code": "string",
            • "counter_currency_code": "string",
            • "type": "string"
            },
          • "transfer_currency_code": "string"
          }
        ],
      • "liquidity_warning": "string",
      • "payment_method": "LOCAL_RAILS",
      • "payment_method_fields": "{\"category_id\":\"bank\",\"required_originator_fields\":[{\"field_name\":\"sender_address\",\"field_label\":\"Sender address\"}]}",
      • "payout_method_info": {
        • "payout_method_name": "Cash Payout",
        • "payout_method_category": "BOOK_TRANSFER",
        • "description": "local rails",
        • "estimated_time_to_credit": "3 days"
        }
      },
    • "fee_info": {
      • "nodes": {
        • "property1": [
          • {
            • "fee_value": 0,
            • "fee_currency": "string",
            • "category": "string",
            • "fee_description": "string"
            }
          ],
        • "property2": [
          • {
            • "fee_value": 0,
            • "fee_currency": "string",
            • "category": "string",
            • "fee_description": "string"
            }
          ]
        },
      • "total_fees": [
        • {
          • "total_fee": 0,
          • "fee_currency": "string"
          }
        ]
      }
    },
  • "ripplenet_info": [
    • {
      • "node_address": "rn.us.ny.new_york",
      • "settlement_declined": [
        • {
          • "info": "L001",
          • "created_at": "2018-04-06T20:33:35Z"
          }
        ]
      }
    ],
  • "execution_condition": "PrefixSha256Condition{subtypes=[ED25519-SHA-256], type=PREFIX-SHA-256, fingerprint=sfGGHCrkyaMsLQNB62w_4zarlPChHKm47JkXVQbs1z0, cost=132360}",
  • "crypto_transaction_id": "4e05da26-7872-4a1f-b9b7-db7604757c37",
  • "validator": "rn.us.ca.san_francisco",
  • "payment_type": "REGULAR",
  • "returns_payment_with_id": "a69b322f-faa4-4531-bcff-897e5839c130",
  • "returned_by_payment_with_id": "c929a87b-81b8-4878-b21c-1aeaa4fe9276",
  • "execution_results": [
    • {
      • "execution_result_id": "06f6d4e2-3523-4d17-92fd-53192a06207f",
      • "execution_timestamp": "2019-10-01T18:24:29.867Z",
      • "execution_result_type": "TRANSFER",
      • "execution_result_order": 1,
      • "sender_address": "trans_usd_sf@rn.us.ca.san_francisco",
      • "receiver_address": "conct_usd_sf@rn.us.ca.san_francisco",
      • "sending_amount": 498,
      • "receiving_amount": 498,
      • "sending_fee": 2,
      • "receiving_fee": 0,
      • "sending_currency_code": "USD",
      • "receiving_currency_code": "GBP",
      • "fx_rate": {
        • "rate": 3.25,
        • "base_currency_code": "string",
        • "counter_currency_code": "string",
        • "type": "string"
        },
      • "transfer_currency_code": "string",
      • "intermediary_delta": 0.2,
      • "incentive_type": "firm",
      • "incentive_value": 0.2,
      • "transaction_hash": 5.5467794184785867e+76,
      • "venue_id": "nz7RpAujYgnQtjEM",
      • "fiat_adjusted_value": 0.02,
      • "odl_payment_id": "string"
      }
    ],
  • "liquidation_execution_results": [
    • {
      • "execution_result_id": "06f6d4e2-3523-4d17-92fd-53192a06207f",
      • "execution_timestamp": "2019-10-01T18:24:29.867Z",
      • "execution_result_type": "TRANSFER",
      • "execution_result_order": 1,
      • "sender_address": "trans_usd_sf@rn.us.ca.san_francisco",
      • "receiver_address": "conct_usd_sf@rn.us.ca.san_francisco",
      • "sending_amount": 498,
      • "receiving_amount": 498,
      • "sending_fee": 2,
      • "receiving_fee": 0,
      • "sending_currency_code": "USD",
      • "receiving_currency_code": "GBP",
      • "fx_rate": {
        • "rate": 3.25,
        • "base_currency_code": "string",
        • "counter_currency_code": "string",
        • "type": "string"
        },
      • "transfer_currency_code": "string",
      • "intermediary_delta": 0.2,
      • "incentive_type": "firm",
      • "incentive_value": 0.2,
      • "transaction_hash": 5.5467794184785867e+76,
      • "venue_id": "nz7RpAujYgnQtjEM",
      • "fiat_adjusted_value": 0.02,
      • "odl_payment_id": "string"
      }
    ],
  • "liquidation_details": {
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "status": "string",
    • "failure_reason": "string",
    • "failure_count": 0
    },
  • "push_forward_execution_results": [
    • {
      • "execution_result_id": "06f6d4e2-3523-4d17-92fd-53192a06207f",
      • "execution_timestamp": "2019-10-01T18:24:29.867Z",
      • "execution_result_type": "TRANSFER",
      • "execution_result_order": 1,
      • "sender_address": "trans_usd_sf@rn.us.ca.san_francisco",
      • "receiver_address": "conct_usd_sf@rn.us.ca.san_francisco",
      • "sending_amount": 498,
      • "receiving_amount": 498,
      • "sending_fee": 2,
      • "receiving_fee": 0,
      • "sending_currency_code": "USD",
      • "receiving_currency_code": "GBP",
      • "fx_rate": {
        • "rate": 3.25,
        • "base_currency_code": "string",
        • "counter_currency_code": "string",
        • "type": "string"
        },
      • "transfer_currency_code": "string",
      • "intermediary_delta": 0.2,
      • "incentive_type": "firm",
      • "incentive_value": 0.2,
      • "transaction_hash": 5.5467794184785867e+76,
      • "venue_id": "nz7RpAujYgnQtjEM",
      • "fiat_adjusted_value": 0.02,
      • "odl_payment_id": "string"
      }
    ],
  • "accepted_at": "2019-10-01T18:25:47.347Z",
  • "locked_at": "2019-10-01T18:25:47.347Z",
  • "executed_at": "2019-10-01T18:25:47.347Z",
  • "completed_at": "2019-10-01T18:25:47.347Z",
  • "returned_at": "2019-10-01T18:25:47.347Z",
  • "internal_info": {
    • "connector_role": "RECEIVING",
    • "labels": [
      • {
        • "label": "string"
        }
      ],
    • "internal_id": "string"
    },
  • "user_info": [
    • {
      • "node_address": "rn.us.ca.san_francisco",
      • "accepted": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "locked": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "lock_declined": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "retry_accept": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "retry_settlement": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "settlement": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "settlement_declined": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "failed": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "executed": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "completed": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "forwarded": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ],
      • "returned": [
        • {
          • "json": { },
          • "created_at": "2019-08-24T14:15:22Z",
          • "subState": "EXECUTING"
          }
        ]
      }
    ]
}

Retry accept payment

Returns a rejected payment from the LOCK_DECLINED state to the ACCEPTED state. The payment sender must include repaired user_info in the request body.

SecurityBearer
Request
path Parameters
payment_id
required
string <uuid>

Unique identifier of the payment to return to ACCEPTED state.

Request Body schema: application/json
user_info
object

Provide one or more arbitrary key/value pairs.

Responses
200

Successfully resubmitted payment for locking.

400

Bad request.

404

Payment not found.

post/payments/{payment_id}/retry_accept
Request samples
application/json
{
  • "user_info": {
    • "SF ACCEPTED": "Payment to NY",
    • "last_name": "Gonzalez",
    • "first_name": "Elle"
    }
}
Response samples
application/json
{
  • "payment_id": "d485f100-2af7-4e48-9ab1-3c7e28775691",
  • "contract_hash": "ccb23bd87f13cc13b9d616a9723f76e112aeac8628b2082e0f8bf3b8c670b103",
  • "payment_state": "COMPLETED",
  • "modified_at": "2019-10-01T18:25:47.347Z",
  • "contract": {
    • "sender_end_to_end_id": "string",
    • "created_at": "2019-10-01T18:18:13.665Z",
    • "expires_at": "2019-10-01T18:55:22.824Z",
    • "quote": {
      • "quote_id": "2a547e56-4aac-4375-86a8-8b3e7014801d",
      • "created_at": "2020-01-29T20:59:44.925Z",
      • "expires_at": "2020-01-29T21:29:44.925Z",
      • "type": "SENDER_AMOUNT",
      • "price_guarantee": "FIRM",
      • "sender_address": "sf@rn.us.ca.san_francisco",
      • "receiver_address": "sf_gbp@rn.us.ca.san_francisco",
      • "amount": 1,
      • "currency_code": "USD",
      • "currency_code_filter": "EUR",
      • "service_type": "string",
      • "quote_elements": [
        • {
          • "quote_element_id": "259189e7-cb14-42e7-99ef-375f3285e356",
          • "quote_element_type": "EXCHANGE",
          • "quote_element_order": 1,
          • "sender_address": "sf@rn.us.ca.san_francisco",
          • "receiver_address": "sf_gbp@rn.us.ca.san_francisco",
          • "sending_amount": 1,
          • "receiving_amount": 355,
          • "sending_fee": 0,
          • "receiving_fee": 0,
          • "sending_currency_code": "USD",
          • "receiving_currency_code": "GBP",
          • "fx_rate": {
            • "rate": 3.25,
            • "base_currency_code": "string",
            • "counter_currency_code": "string",
            • "type": "string"
            },
          • "transfer_currency_code": "string"
          }
        ],
      • "liquidity_warning": "string",
      • "payment_method": "LOCAL_RAILS",
      • "payment_method_fields": "{\"category_id\":\"bank\",\"required_originator_fields\":[{\"field_name\":\"sender_address\",\"field_label\":\"Sender address\"}]}",
      • "payout_method_info": {
        • "payout_method_name": "Cash Payout",
        • "payout_method_category": "BOOK_TRANSFER",
        • "description": "local rails",
        • "estimated_time_to_credit": "3 days"
        }
      },
    • "fee_info": {
      • "nodes": {
        • "property1": [
          • {
            • "fee_value": 0,
            • "fee_currency": "string",
            • "category": "string",
            • "fee_description": "string"
            }
          ],
        • "property2": [
          • {
            • "fee_value": 0,
            • "fee_currency": "string",
            • "category": "string",
            • "fee_description": "string"
            }
          ]
        },
      • "total_fees": [
        • {
          • "total_fee": 0,
          • "fee_currency": "string"
          }
        ]
      }
    },
  • "ripplenet_info": [
    • {
      • "node_address": "rn.us.ny.new_york",
      • "settlement_declined": [
        • {
          • "info": "L001",
          • "created_at": "2018-04-06T20:33:35Z"
          }
        ]
      }
    ],
  • "execution_condition": "PrefixSha256Condition{subtypes=[ED25519-SHA-256], type=PREFIX-SHA-256, fingerprint=sfGGHCrkyaMsLQNB62w_4zarlPChHKm47JkXVQbs1z0, cost=132360}",
  • "crypto_transaction_id": "4e05da26-7872-4a1f-b9b7-db7604757c37",
  • "validator": "rn.us.ca.san_francisco",
  • "payment_type": "REGULAR",
  • "returns_payment_with_id": "a69b322f-faa4-4531-bcff-897e5839c130",
  • "returned_by_payment_with_id": "c929a87b-81b8-4878-b21c-1aeaa4fe9276",
  • "execution_results": [
    • {
      • "execution_result_id": "06f6d4e2-3523-4d17-92fd-53192a06207f",
      • "execution_timestamp": "2019-10-01T18:24:29.867Z",
      • "execution_result_type": "TRANSFER",
      • "execution_result_order": 1,
      • "sender_address": "trans_usd_sf@rn.us.ca.san_francisco",
      • "receiver_address": "conct_usd_sf@rn.us.ca.san_francisco",
      • "sending_amount": 498,
      • "receiving_amount": 498,
      • "sending_fee": 2,
      • "receiving_fee": 0,
      • "sending_currency_code": "USD",
      • "receiving_currency_code": "GBP",
      • "fx_rate": {
        • "rate": 3.25,
        • "base_currency_code": "string",
        • "counter_currency_code": "string",
        • "type": "string"
        },
      • "transfer_currency_code": "string",
      • "intermediary_delta": 0.2,
      • "incentive_type": "firm",
      • "incentive_value": 0.2,
      • "transaction_hash": 5.5467794184785867e+76,
      • "venue_id": "nz7RpAujYgnQtjEM",
      • "fiat_adjusted_value": 0.02,
      • "odl_payment_id": "string"
      }
    ],
  • "liquidation_execution_results": [
    • {
      • "execution_result_id": "06f6d4e2-3523-4d17-92fd-53192a06207f",
      • "execution_timestamp": "2019-10-01T18:24:29.867Z",
      • "execution_result_type": "TRANSFER",
      • "execution_result_order": 1,
      • "sender_address": "trans_usd_sf@rn.us.ca.san_francisco",
      • "receiver_address": "conct_usd_sf@rn.us.ca.san_francisco",
      • "sending_amount": 498