Skip to main content
The Get Payment endpoint retrieves the complete details of a specific payment using its unique identifier. You can use this endpoint to poll the current status of a payment, confirm delivery, or surface transaction details in your own dashboard. The payment object returned is identical in structure to the one returned when you created the payment.

​
Path Parameters

​
id
string
required
The unique payment identifier, prefixed with pmt_ (e.g., pmt_01HX4N3RABCDEF). This is returned in the id field when you create a payment.

​
Response

​
id
string
Unique payment identifier with prefix pmt_.
​
status
string
Current lifecycle status of the payment. Possible values:
ValueDescription
pendingPayment received and queued for processing.
processingOn-chain settlement is in progress.
settledStablecoin settlement confirmed on-chain.
deliveredFunds delivered to the recipient’s bank account.
failedPayment could not be completed.
cancelledPayment was cancelled before processing began.
​
amount
number
The source payment amount originally submitted.
​
currency
string
Source stablecoin used for the payment.
​
destination_currency
string
Target currency the recipient receives.
​
converted_amount
number
Amount delivered to the recipient in destination_currency, after applying the exchange rate and deducting fees.
​
exchange_rate
number
The applied conversion rate from currency to destination_currency.
​
fee
number
Total RemitFlex fee deducted from the payment, denominated in currency.
​
recipient
object
Recipient details associated with the payment.
​
reference
string
The internal reference you provided at creation, if any.
​
corridor
string
The corridor identifier used to route the payment.
​
created_at
string
ISO 8601 timestamp of when the payment was created.
​
updated_at
string
ISO 8601 timestamp of the most recent status update.
​
estimated_delivery
string
ISO 8601 timestamp of the projected delivery time to the recipient’s bank account.

​
Examples

curl https://api.remitflex.com/v1/payments/pmt_01HX4N3RABCDEF \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "id": "pmt_01HX4N3RABCDEF",
  "status": "delivered",
  "amount": 500,
  "currency": "USDC",
  "destination_currency": "EUR",
  "converted_amount": 461.25,
  "exchange_rate": 0.9225,
  "fee": 2.50,
  "corridor": "US-EU",
  "recipient": {
    "name": "Maria Garcia",
    "account_number": "ES9121000418401234567891",
    "bank_country": "ES"
  },
  "reference": "Invoice #INV-2024-001",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T14:28:11Z",
  "estimated_delivery": "2024-01-15T14:30:00Z"
}

​
Error Responses

If the payment ID does not exist or does not belong to your account, the API returns a 404 Not Found response. 
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Payment pmt_01HX4N3RABCDEF not found."
  }
}