Sign in
PaymentRequests

Gets a minimal representation of a payment request.

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

Request

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

Path parameters

idstring uuid required

The ID of the payment request to retrieve.

Response

Returns a payment request minimal record.

idstring uuid
merchantIDstring uuid
merchantNamestring nullable
merchantShortNamestring nullable
merchantLogoUrlPngstring nullable
merchantLogoUrlSvgstring nullable
amountnumber double

The amount of money to request.

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 currency of the request.

titlestring nullable

The title of the payment request.

descriptionstring nullable

An optional description for the payment request. If set this field will appear on the transaction record for some card processors.

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

The card processor

paymentProcessorKeystring nullable

The card processors public key

callbackUrlstring nullable
cardStripePaymentIntentSecretstring nullable
jwkstring nullable

The jwk containing the public key

paymentMethodsListstring[] nullable

The payment methods that the payment request supports.

pispErrorstring nullable

This is the error returned from the bank which is recorded in payment request events.

priorityBankIDstring uuid nullable
googlePayMerchantIDstring nullable

Merchant ID from Google Pay

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

The status of the payment request.

partialPaymentMethod'None' | 'Partial'
stripeAccountIDstring nullable

Account ID of connected customers in Stripe

countryCodestring nullable

The country code associated with the payment.

dueDatestring date-time nullable

The due date of the payment request.

amountReceivednumber double

The amount of money that has been received for this payment request.

amountRefundednumber double

The amount of money that has been refunded for this payment request.

amountPendingnumber double

The amount of money that was authorised but has not arrived in the account yet.

Changes

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