Sign in
PaymentRequests

Gets a payment requests's events.

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

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

Request

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

Path parameters

idstring uuid required

ID of the payment request to get the events for.

Response

Returns a list of payment request event records.

idstring uuid
paymentRequestIDstring uuid
insertedstring date-time
eventType'unknown' | 'card_payer_authentication_setup' | 'card_authorization' | 'card_sale' | 'card_capture' | 'card_void' | 'pisp_initiate' | 'pisp_callback' | 'lightning_invoice_created' | 'lightning_invoice_paid' | 'card_payer_authentication_failure' | 'pisp_webhook' | 'pisp_settle' | 'pisp_settle_failure' | 'pisp_refund_initiated' | 'pisp_refund_settled' | 'pisp_refund_cancelled' | 'card_webhook' | 'card_refund' | 'lightning_invoice_expired' | 'lightning_invoice_cancelled' | 'direct_debit_initiate' | 'direct_debit_create' | 'direct_debit_state_change' | 'direct_debit_paid' | 'direct_debit_failed' | 'card_refund_pending' | 'card_refund_settled' | 'card_refund_declined'
amountnumber double required
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'
statusstring nullable
errorReasonstring nullable
errorMessagestring nullable
cardRequestIDstring nullable
cardTransactionIDstring nullable
cardTokenCustomerIDstring nullable

If the option to create a reusable token for card payments was set this field contains the token the merchant can store to use for repeat payments.

cardAuthorizationResponseIDstring nullable

For a successful card authorization this field will hold the response ID. If a capture needs to be performed this is the ID that must be used.

lightningInvoicestring nullable

For Bitcoin Lightning payments this field holds the invoice presented to the payer.

lightningRHashstring nullable

For Bitcoin Lightning payments the hash of the invoice presented to the payer.

pispPaymentServiceProviderIDstring nullable

For a payment initiation this is the service provider ID selected by the payer, typically the ID for the bank or similar financial institution.

pispPaymentInitiationIDstring nullable

For a payment initiation this is the ID returned by the service provider initiating the payment for us.

pispRedirectUrlstring nullable

For a payment initiation this is the redirect URL returned by the service provider initiating the payment for us. This is the URL the payer is redirected to authenticate with their financial institution and authorise the payment.

paymentProcessorName'None' | 'CyberSource' | 'Checkout' | 'Stripe' | 'Modulr' | 'Plaid' | 'Yapily' | 'Nofrixion' | 'Bitcoin' | 'BitcoinTestnet' | 'BankingCircle' | 'BankingCircleAgency' | 'Simulator' | 'Lightning' | 'LightningTestnet' | 'BankingCircleDirectDebit' | 'Technoxander'

If the event was for a card payment this is the name of the card processor, e.g. CyberSource or Checkout, that was used.

pispBankStatusstring nullable

For payment initiation attempts some providers (e.g. Modulr) will return two status fields. The first status field is from the provider and the second is from the bank.

walletName'ApplePay' | 'GooglePay' nullable
refundPayoutIDstring uuid nullable

ID of the Payout that was created for refund.

applePayTransactionIDstring nullable

Transaction ID received in Apple pay token.

pispPaymentInstitutionNamestring nullable

For a payment initiation this is the name of the financial institution that is used to initiate and authorise the payment.

originUrlstring nullable

Optional field that can be set by payment methods, such as pay by bank, that may want to redirect back to the URL that initiated the attempt in the case of a failure condition.

reconciledTransactionIDstring uuid nullable

For settlement events (only relevant for non-card payments) this is the payin transaction that the payment request event was reconciled with.

directDebitPaymentIDstring nullable

Payment ID issued by the Direct Debit supplier.

directDebitPaymentReferencestring nullable

Reference string issued by the Direct Debit supplier.

drirectDebitMandateIDstring uuid nullable

The ID of the mandate that was used wehn requesting payment.

cardSchemestring nullable

For card payment events this field holds the scheme of the payer's card, e.g. Visa, Mastercard, etc.

cardExpiryYearinteger nullable

For card payment events this field holds the payer's card expiry year.

cardExpiryMonthinteger nullable

For card payment events this field holds the payer's card expiry month.

cardLastFourDigitsstring nullable

For card payment events this field holds the payer's card last four digits.

cardIssuerstring nullable

For card payment events this field holds the payer's card issuer.

cardIssuerCountrystring nullable

For card payment events this field holds the payer's card issuer country of origin.

paymentMethodType'None' | 'card' | 'pisp' | 'lightning' | 'cardtoken' | 'applePay' | 'googlePay' | 'directDebit'

The type of payment method the event relates to, e.g. card, pisp, etc.

Changes

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