v13

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-03-243075159.3 KB

Sending Payments

Retry an incomplete payment

In the case where a customer is debited but the Lightning payment fails to complete, integrators can retry the payment using this endpoint.

Payments retried with this endpoint will debit from the sender and deliver to the recipient the same amount as the original quote. As UMA as a service does not persist customer PII, retries need to start with a lookup request to retrieve the original quote's recipient counter party data requirements then pass that sender information in the request body. Before calling this endpoint, you should reach out to the UMA as a service team to investigate the underlying issue. As part of resolution, they'll update the transaction to the appropriate state. The quote / transaction to retry must be in a FAILED or REFUNDED state.

post/quotes/{quoteId}/retry

Path parameters

quoteIdstring required

ID of the quote to retry

Request body

lookupIdstring required

Unique identifier for the prior receiver uma address lookup request.

senderUserInfoobject

Key-value pairs of information about the sender which was requested by the counterparty (recipient) institution. Any fields specified in requiredPayerDataFields from the response of the /receiver/{receiverUmaAddress} (lookupUma) endpoint MUST be provided here if they were requested. If the counterparty (recipient) institution did not request any information, this field can be omitted.

Example request

{
  "lookupId": "Lookup:019542f5-b3e7-1d02-0000-000000000009",
  "senderUserInfo": {
    "FULL_NAME": "Jane Receiver",
    "NATIONALITY": "FR"
  }
}

Response

Quote created successfully. The response includes payment instructions that the client can use to execute the payment through their banking provider.

quoteIdstring required

Unique identifier for this quote

totalSendingAmountinteger required

The total amount that will be sent in the smallest unit of the sending currency (eg. cents).

totalReceivingAmountinteger required

The total amount that will be received in the smallest unit of the receiving currency (eg. cents).

exchangeRatenumber required

Number of sending currency units per receiving currency unit.

expiresAtstring date-time required

When this quote expires (typically 1-5 minutes after creation)

feesIncludedinteger required

The fees associated with the quote in the smallest unit of the sending currency (eg. cents).

counterpartyInformationobject

Information about the recipient, as required by the platform in their configuration.

status'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'EXPIRED'

Current status of the quote

transactionIdstring required

The ID of the transaction created from this quote.

originalQuoteIdstring

ID of the quote that is being retried

Example response

{
  "quoteId": "Quote:019542f5-b3e7-1d02-0000-000000000006",
  "sendingCurrency": {
    "code": "USD",
    "name": "United States Dollar",
    "symbol": "$",
    "decimals": 2
  },
  "receivingCurrency": {
    "code": "USD",
    "name": "United States Dollar",
    "symbol": "$",
    "decimals": 2
  },
  "totalSendingAmount": 123010,
  "totalReceivingAmount": 1000,
  "expiresAt": "2023-09-01T14:30:00Z",
  "feesIncluded": 10,
  "counterpartyInformation": {
    "FULL_NAME": "Jane Receiver",
    "BIRTH_DATE": "1990-01-01",
    "NATIONALITY": "FR"
  },
  "paymentInstructions": {
    "reference": "UMA-Q12345-REF",
    "instructionsNotes": "Please ensure the reference code is included in the payment memo/description field",
    "bankAccountInfo": {
      "clabeNumber": "123456789012345678",
      "bankName": "BBVA Mexico",
      "accountHolderName": "John Doe"
    }
  },
  "status": "PENDING",
  "transactionId": "Transaction:019542f5-b3e7-1d02-0000-000000000005",
  "originalQuoteId": "Quote:019542f5-b3e7-1d02-0000-000000000001",
  "rateDetails": {
    "counterpartyMultiplier": 1.08,
    "counterpartyFixedFee": 10,
    "umaaasMultiplier": 0.925,
    "umaaasFixedFee": 10,
    "umaaasVariableFeeRate": 0.003,
    "umaaasVariableFeeAmount": 30
  }
}