Sign in
PaymentRequests

Submits a request to void all payments for a payment request.

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

post/api/v1/paymentrequests/{id}/card/voidpaymentrequest

Request

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

Path parameters

idstring uuid required

The ID of the payment request to void the payments for.

Response

Returns a collection of card payment response models that indicates the result of the void payment request attempt.

authorizedAmountstring nullable
currencyCodestring nullable
responseCodestring nullable
statusstring nullable
requestIDstring nullable
transactionIDstring nullable
isPayerAuthenticationRequiredboolean

Gets set to true if 3-D Secure payer authentication is required for a payment.

isSoftDeclineboolean

Gets set to true if the card processor flagged the transaction as having failed address or card security number verification. If the payment was for a sale a soft decline will prevent the transaction being captured. The merchant can set the ignore address verification flag if they want to allow soft declines to be accepted or false if not.

payerAuthenticationUrlstring nullable

If a card payment response indicates a 3-D Secure payer authentication is required this field holds the URL to redirect the payer to their issuing bank.

payerAuthenticationAccessTokenstring nullable

If a card payment response indicates a 3-D Secure payer authentication is required this field holds the access token to POST when performing the redirect.

payerAuthenticationWindowWidthinteger

If a card payment response indicates a 3-D Secure payer authentication is required this field holds the requested width of the iframe used to hold the challenge.

payerAuthenticationWindowHeightinteger

If a card payment response indicates a 3-D Secure payer authentication is required this field holds the requested height of the iframe used to hold the challenge.

payerAuthenticationMerchantDatastring nullable

If a card payment response indicates a 3-D Secure payer authentication this field may get set in order to transfer information back to the "authenticationcallback" method that gets called automatically after a successful payer authentication attempt.

paymentRequestCallbackUrlstring nullable

The callback URL that was set when the payment request was created. Payers will be redirected to this URL after a successful card authorisation.

threeDSRedirectUrlstring nullable

Checkout.com require a redirect for 3DS authentication. This link will contain the link the payer needs to be redirected to.

paymentRequestIDstring uuid
responseType'None' | 'CardPayerAuthenticationSetupResponse' | 'CardPaymentResponse' | 'PaymentInitiationResponse'

Changes

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