Sign in

v13

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

Reject a pending incoming payment

Reject a pending incoming payment that was previously acknowledged with a 202 response. This endpoint allows platforms to asynchronously reject payments after additional processing.

post/transactions/{transactionId}/reject

Path parameters

transactionIdstring required

Unique identifier of the transaction to reject

Request body

reasonstring

Optional reason for rejecting the payment. This is just for debugging purposes or can be used for a platform's own purposes.

Example request

{
  "reason": "RESTRICTED_JURISDICTION"
}

Response

Payment rejected successfully

idstring required

Unique identifier for the transaction

status'CREATED' | 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'REJECTED' | 'FAILED' | 'REFUNDED' | 'EXPIRED' required

Status of a payment transaction

type'INCOMING' | 'OUTGOING' required

Type of transaction (incoming payment or outgoing payment)

senderUmaAddressstring required

UMA address of the payment sender

receiverUmaAddressstring required

UMA address of the payment recipient

userIdstring required

System ID of the user (sender for outgoing, recipient for incoming)

platformUserIdstring required

Platform-specific ID of the user (sender for outgoing, recipient for incoming)

settledAtstring date-time

When the payment was or will be settled

createdAtstring date-time

When the transaction was created

descriptionstring

Optional memo or description for the payment

counterpartyInformationobject

Additional information about the counterparty, if available

failureReason'LNURLP_FAILED' | 'PAY_REQUEST_FAILED' | 'PAYMENT_APPROVAL_WEBHOOK_ERROR' | 'PAYMENT_APPROVAL_TIMED_OUT' | 'OFFRAMP_FAILED' | 'MISSING_MANDATORY_PAYEE_DATA' | 'QUOTE_EXPIRED' | 'QUOTE_EXECUTION_FAILED'

Reason for failure of an incoming transaction. This is used to provide more context on why a transaction failed. If the transaction is not in a failed state, this field is omitted.

Example response

{
  "id": "Transaction:019542f5-b3e7-1d02-0000-000000000004",
  "senderUmaAddress": "$sender@external.domain",
  "receiverUmaAddress": "$recipient@uma.domain",
  "userId": "User:019542f5-b3e7-1d02-0000-000000000001",
  "platformUserId": "18d3e5f7b4a9c2",
  "settledAt": "2023-08-15T14:30:00Z",
  "createdAt": "2023-08-15T14:25:18Z",
  "description": "Payment for invoice #1234",
  "counterpartyInformation": {
    "FULL_NAME": "John Sender",
    "BIRTH_DATE": "1985-06-15",
    "NATIONALITY": "DE"
  },
  "receivedAmount": {
    "amount": 12550,
    "currency": {
      "code": "USD",
      "name": "United States Dollar",
      "symbol": "$",
      "decimals": 2
    }
  },
  "reconciliationInstructions": {
    "reference": "UMA-Q12345-REF"
  },
  "rateDetails": {
    "umaaasMultiplier": 0.925,
    "umaaasFixedFee": 10,
    "umaaasVariableFeeRate": 0.003,
    "umaaasVariableFeeAmount": 30
  }
}