Sign in
PaymentRequests

Gets a payment request result.

<b>Authorization</b>: End user or Merchant token is required.

get/api/v1/paymentrequests/{id}/result

Request

  • Base URL: https://api.nofrixion.com
  • URL: https://api.nofrixion.com/api/v1/paymentrequests/{id}/result
  • Auth: API key in header Authorization

Path parameters

idstring uuid required

ID of the payment request to get the result for.

Response

Returns a payment request result record.

paymentRequestIDstring uuid

The ID of the payment request the result is for.

amountnumber double

The authorised payment amount.

currency'NONE' | 'GBP' | 'EUR' | 'USD' | 'AUD' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ISK' | 'CHF' | 'NOK' | 'PLN' | 'RON' | 'AED' | 'CNH' | 'HKD' | 'ILS' | 'JPY' | 'MXN' | 'NZD' | 'SAR' | 'SEK' | 'SGD' | 'TRY' | 'ZAR' | 'BTC'

The authorised payment currency.

result'None' | 'FullyPaid' | 'PartiallyPaid' | 'OverPaid' | 'Voided' | 'Authorized'

The result of the payment attempt.

requestedAmountnumber double

The full original payment amount requested.

amountReceivednumber double
amountRefundednumber double
amountPendingnumber double
customerIDstring nullable

The customer id

Changes

No recorded changes to this endpoint across all 2 revisions of this API.