Cancel a Payment – Nuvei Documentation

Definition: POST /v1/payments/{id}/cancel

Where:

{id} – GlobalPay Payment ID

A payment can be cancelled if it has an Authorized or an Open status. The Authorized status can only be obtained for some payment methods like: Cards, Klarna methods, Cards Russsia, Paysafecard, Paypal and PostFinance.

A payment with an Open status can be cancelled if the payment has been initiated but the customer hasn’t accessed the RedirectURL or the customer didn’t get to the provider’s side. For the offline payment methods the payment can be cancelled if the customer hasn’t yet received the payment details.

A 200 HTTP response (OK) is returned if the request was completed successfully.

Request:

POST https://paytest.smart2pay.com/v1/payments/3897979/cancel
Authorization: Basic MzAyMDE6aEo1Um9iWXg5cjdGZk53Q3ZIWTlMWEhxcXIrRkV6cmM3YUp2UVFrNEdhejFtZzdSeXk=

Response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "Payment": {
    "ID": 3897979,
    "SkinID": 11,
    "ClientIP": null,
    "Created": "20180615091144",
    "MerchantTransactionID": "s2ptest_g242",
    "OriginatorTransactionID": null,
    "Amount": "899",
    "Currency": "GBP",
    "CapturedAmount": null,
    "ReturnURL": "http://demo.smart2pay.com/redirect.php",
    "Description": null,
    "MethodID": 1078,
    "MethodOptionID": null,
    "IncludeMethodIDs": null,
    "ExcludeMethodIDs": null,
    "PrioritizeMethodIDs": null,
    "SiteID": 30201,
    "NotificationDateTime": "20180615091304",
    "Customer": {
      "ID": 340,
      "MerchantCustomerID": "0125",
      "Email": "youremail@email.com",
      "FirstName": "Doe",
      "LastName": "Test",
      "Gender": "0",
      "SocialSecurityNumber": "0801363945",
      "Phone": "+440745785615",
      "Company": "S2P",
      "DateOfBirth": null
      },
    "BillingAddress": {
      "ID": 3959,
      "City": "London",
      "ZipCode": "W13 3BG",
      "State": "London",
      "Street": "New Burlington St 113",
      "StreetNumber": "Apt 214",
      "HouseNumber": null,
      "HouseExtension": null,
      "Country": "GB"
      },
    "ShippingAddress": {
      "ID": 3959,
      "City": "London",
      "ZipCode": "W13 3BG",
      "State": "London",
      "Street": "New Burlington St 113",
      "StreetNumber": "Apt 214",
      "HouseNumber": null,
      "HouseExtension": null,
      "Country": "GB"
      },
    "Articles": [
      {
      "MerchantArticleID": "1235",
      "Name": "Physical",
      "Quantity": 1,
      "Price": "1000",
      "VAT": "1200",
      "Discount": "0.09",
      "Type": "5",
      "DiscountValue": "100"
      }
    ],
    "Details": null,
    "ReferenceDetails": null,
    "CustomParameters": null,
    "PreapprovalID": null,
    "Status": {
      "ID": 3,
      "Info": "Cancelled",
      "Reasons": null
      },
    "MethodTransactionID": null,
    "TokenLifetime": null,
    "Capture": null,
    "PreapprovalDetails": null,
    "RedirectURL": null
  }
}

{"Payment":{"hint":"Payment structure","regexp":"","type":"object","ID":{"hint":"GlobalPay transaction ID, a unique number that identifies the transaction in the GlobalPay system.","regexp":"^\\d{1,12}$","type":"int"},"SkinID":{"hint":"Skin ID to be used","regexp":"^\\d{1,12}$","type":"int"},"ClientIP":{"hint":"The IP address of the customer","regexp":"^\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}$","type":"string"},"Created":{"hint":"Date and time when the transaction was created in GlobalPay system.","regexp":"","type":"datetime"},"MerchantTransactionID":{"hint":"Merchant Transaction ID, a number that uniquely identifies a transaction in your system.","regexp":"^[0-9a-zA-Z_-]{1,50}$","type":"string"},"OriginatorTransactionID":{"hint":"Originator transaction ID, a number that uniquely identifies the transaction in the original requester\u2019s system.","regexp":"^[0-9a-zA-Z_-]{1,50}$","type":"string"},"Amount":{"hint":"The service(s)\/product(s) price on your website or application. The last two digits represent the decimal part (11.54 will be sent 1154). Please be aware that data type string is also accepted as long as it contains only digits","regexp":"^\\d{1,12}$","type":"int"},"Currency":{"hint":"The currency in which you sell the services or products. Format is according to ISO 4217, a three-letter code.","regexp":"^[A-Z]{3}$","type":"string"},"CapturedAmount":{"hint":"The payment\u2018s captured amount. The last two digits represent the decimal part (11.54 will be sent 1154). Please be aware that data type string is also accepted as long as it contains only digits.","regexp":"^\\d{1,12}$","type":"int"},"ReturnURL":{"hint":"An URL at your end where the customer will be redirected after the payment process ends.","regexp":"^(http(s)?(:\\\/\\\/|%3A%2F%2F).+){1,512}$","type":"string"},"Description":{"hint":"Text describing the service or product sold; will be displayed on the payment page.","regexp":"^.{1,255}$","type":"string"},"MethodID":{"hint":"The ID of the payment method.","regexp":"^\\d{1,12}$","type":"int"},"MethodOptionID":{"hint":"The ID of the payment option; can be used when the payment method has multiple payment options (e.g. ING bank is an option for iDEAL).","regexp":"^([0-9]{1,10})$","type":"int"},"IncludeMethodIDs":{"hint":"Methods can be included in this list and will be shown to the customer on the payment page. Subset of Smart2Pay payment methods from the ones assigned to you.","regexp":"","type":"array"},"ExcludeMethodIDs":{"hint":"Excluded methods will be shown to the customer in this list on the payment page. Subset of Smart2Pay payment methods from the ones assigned to you.","regexp":"","type":"array"},"PrioritizeMethodIDs":{"hint":"A sorted list of methods assigned to you. This is the order in which the methods will be displayed in the payment page.","regexp":"","type":"array"},"SiteID":{"hint":"The ID of the site","regexp":"^([0-9]{1,10})$","type":"int"},"NotificationDateTime":{"hint":"Date and time of payment notification","regexp":"","type":"datetime"},"Customer":{"hint":"Customer details","regexp":"","type":"object","ID":{"hint":"Customer ID, a unique number that identifies the customer in the GlobalPay system.","regexp":"^\\d{1,12}$","type":"int"},"MerchantCustomerID":{"hint":"The ID of the customer in your system.","regexp":"^([0-9a-zA-Z_-]{1,50})?$","type":"string"},"Email":{"hint":"Customer\u2019s email","regexp":"^[a-zA-Z0-9\\._%+-]{1,100}@[a-zA-Z0-9\\.-]{1,40}\\.[a-zA-Z]{1,8}$","type":"string"},"FirstName":{"hint":"Customer\u2019s first name","regexp":"","type":"string"},"LastName":{"hint":"Customer\u2019s last name","regexp":"","type":"string"},"Gender":{"hint":"Customer\u2019s gender. It can have the following values: 1 - Male, 2 - Female.","regexp":"","type":"string"},"DateOfBirth":{"hint":"Customer date of birth","regexp":"^(((19|20)\\d\\d)(0[1-9]|1[012])(0[1-9]|[12][0-9]|3[01]))$","type":"date"},"SocialSecurityNumber":{"hint":"Customer\u2018s social or fiscal identifier","regexp":"","type":"string"},"Phone":{"hint":"Customer\u2019s phone including prefix","regexp":"","type":"string"},"Company":{"hint":"Company name (for legal entities)","regexp":"","type":"string"},"InputDateTime":{"hint":"Customer creation date","regexp":"","type":"datetime"}},"BillingAddress":{"hint":"Billing Address details","regexp":"","type":"object","ID":{"hint":"Address ID, a unique number that identifies an address in the GlobalPay system.","regexp":"^\\d{1,12}$","type":"int"},"Country":{"hint":"Customer\u2018s country. Recommended to be sent in order to increase the conversion. If MethodID is missing, this field (taken from BillingAddress object) controls which payment methods are shown on the hosted payment pages. Format is according to ISO-3166-1 alpha-2, a two-letter code.","regexp":"^([A-Za-z]{2})?$","type":"string"},"City":{"hint":"City name","regexp":"^(.{1,255})?$","type":"string"},"ZipCode":{"hint":"Postal code","regexp":"^(.{1,255})?$","type":"string"},"State":{"hint":"State name","regexp":"^(.{1,255})?$","type":"string"},"Street":{"hint":"Street name","regexp":"^(.{1,255})?$","type":"string"},"StreetNumber":{"hint":"Street Number","regexp":"^(.{1,255})?$","type":"string"},"HouseNumber":{"hint":"House Number","regexp":"^(.{1,255})?$","type":"string"},"HouseExtension":{"hint":"House Extension","regexp":"^(.{1,255})?$","type":"string"}},"ShippingAddress":{"hint":"Shipping Address details","regexp":"","type":"object","ID":{"hint":"Address ID, a unique number that identifies an address (where you want your items delivered) in the GlobalPay system.","regexp":"^\\d{1,12}$","type":"int"},"Country":{"hint":"Shipping country, where your customer\u2018s items should be delivered. It can be the same as the customer\u2018s billing address, or it can be different. Format is according to ISO-3166-1 alpha-2, a two-letter code.","regexp":"^([A-Za-z]{2})?$","type":"string"},"City":{"hint":"City name","regexp":"^(.{1,255})?$","type":"string"},"ZipCode":{"hint":"Postal code","regexp":"^(.{1,255})?$","type":"string"},"State":{"hint":"State name","regexp":"^(.{1,255})?$","type":"string"},"Street":{"hint":"Street name","regexp":"^(.{1,255})?$","type":"string"},"StreetNumber":{"hint":"Street Number","regexp":"^(.{1,255})?$","type":"string"},"HouseNumber":{"hint":"House Number","regexp":"^(.{1,255})?$","type":"string"},"HouseExtension":{"hint":"House Extension","regexp":"^(.{1,255})?$","type":"string"}},"Articles":{"hint":"The services\/products purchased from the website. Mandatory to be sent for Klarna Invoice and Klarna Payments payment methods.","regexp":"","type":"array of objects","MerchantArticleID":{"hint":"The ID of the article in your system","regexp":"^\\d{1,19}$","type":"string"},"Name":{"hint":"Article\u2019s name","regexp":"^.{1,250}$","type":"string"},"Quantity":{"hint":"The number of products. If is not sent the default value is 1.","regexp":"^\\d{1,3}$","type":"int"},"Price":{"hint":"The price for one item","regexp":"","type":"int"},"VAT":{"hint":"Value-Added Tax ( it is a tax in percent on the purchase price)","regexp":"^\\d{1,4}$","type":"int"},"Discount":{"hint":"The percent on the original price offered by you as discount. The last two digits represent the decimal part (10% will be sent 1000).","regexp":"^\\d{1,4}$","type":"int"},"DiscountValue":{"hint":"The fixed value on the original price offered by you as discount. The last two digits represent the decimal part (10 GBP will be sent 1000).","regexp":"^\\d{1,4}$","type":"int"},"Type":{"hint":"The type of article. It can have the following values: 4 - Discount, 5 -Physical, 6 - Shipping_fee, 7 - Sales_tax, 8 - Digital, 9 - Gift_card, 10 - Store_credit, 11 - Surcharge.","regexp":"^(1|2|3|4|5|6|7|8|9|10|11)$","type":"int"},"TaxType":{"hint":"The type of tax. It can have the following values: 1 - without VAT, 2 - VAT at the rate of 0%, 3 - VAT of the receipt at the rate of 10%, 4 - VAT of the receipt at the rate of 18%, 5 - VAT of the receipt at the applicable rate of 10\/110, 6 - VAT of the receipt at the applicable rate of 18\/118.","regexp":"^(1|2|3|4|5|6)$","type":"int"}},"Splits":{"hint":"","regexp":"","type":"array of objects","ID":{"hint":"Payment split ID","regexp":"^\\d{1,12}$","type":"int"},"PaymentID":{"hint":"Payment ID","regexp":"^\\d{1,12}$","type":"int"},"SiteID":{"hint":"The ID of the site","regexp":"^\\d{1,12}$","type":"int"},"MerchantTransactionID":{"hint":"Payment merchant assigned transaction ID","regexp":"","type":"string"},"OriginatorTransactionID":{"hint":"Originator transaction ID, a number that uniquely identifies the transaction in the original requester\u2019s system.","regexp":"^[0-9a-zA-Z_-]{1,50}$","type":"string"},"Created":{"hint":"Split payment creation time","regexp":"","type":"datetime"},"Amount":{"hint":"Split payment amount","regexp":"^\\d{1,12}$","type":"int"},"Currency":{"hint":"The currency in which you sell the services or products. Format is according to ISO 4217, a three-letter code.","regexp":"^[A-Z]{3}$","type":"string"},"CapturedAmount":{"hint":"Payment amount captured","regexp":"^\\d{1,12}$","type":"int"},"Status":{"hint":"","regexp":"","type":"object","ID":{"hint":"Status ID","regexp":"","type":"int"},"Info":{"hint":"The description of the status","regexp":"","type":"string"},"Reasons":{"hint":"The reasons why the payment got to this status.","regexp":"","type":"array of objects","Code":{"hint":"The id of the message type transmitted in the response. See our section GlobalPay Return Codes for a complete description.","regexp":"","type":"int"},"Info":{"hint":"The message body","regexp":"","type":"string"}}}},"Details":{"hint":"In some cases we send various details about the payment (e.g. Reference Number and Bank Details of the Customer for Bank Transfer payments).","regexp":"","type":"object","BankCode":{"hint":"Customer\u2019s Bank Code. Also known as BIC or Swift_BIC. Bank Identifier Code (BIC), a unique identification code for a particular bank (consists of 8-11 alphanumeric characters).","regexp":"","type":"string"},"AccountNumber":{"hint":"Account number","regexp":"","type":"string"},"IBAN":{"hint":"IBAN (International Bank Account Number) a code (up to 34 alphanumeric characters) that uniquely identifies an account held at any bank anywhere in the world.","regexp":"","type":"string"},"BIC":{"hint":"Bank Identifier Code (BIC), a unique identification code for a particular bank (consists of 8-11 alphanumeric characters).","regexp":"","type":"string"},"EntityID":{"hint":"Payment entity ID","regexp":"","type":"string"},"ReferenceID":{"hint":"Payment reference ID","regexp":"","type":"string"},"EntityNumber":{"hint":"Payment entity number","regexp":"","type":"string"},"ReferenceNumber":{"hint":"Payment reference number","regexp":"","type":"string"},"AccountHolder":{"hint":"The person whose name is on the bank account.","regexp":"","type":"string"},"BankName":{"hint":"The name of the Bank","regexp":"","type":"string"},"BankSortCode":{"hint":"Bank sort code identifies both the bank and the branch where the account is held (consists of 6 digits).","regexp":"","type":"string"},"SocialSecurityNumber":{"hint":"Payer social security number","regexp":"","type":"string"},"SWIFT_BIC":{"hint":"Swift Code, a standard format of Bank Identifier Codes (BIC), is a unique identification code for a particular bank (consists of 8-11 alphanumeric characters).","regexp":"","type":"string"},"AccountCurrency":{"hint":"The currency in which the account is kept. Format is according to ISO 4217, a three-letter code.","regexp":"","type":"string"},"PrepaidCard":{"hint":"Prepaid card number","regexp":"","type":"string"},"PrepaidCardPIN":{"hint":"Prepaid card PIN","regexp":"","type":"string"},"SerialNumbers":{"hint":"Serial numbers","regexp":"","type":"string"},"Wallet":{"hint":"Customer wallet","regexp":"","type":"string"},"PayerCountry":{"hint":"Payer country ISO 2 characters","regexp":"^[a-zA-Z]{2}$","type":"string"},"PayerEmail":{"hint":"Payer email address","regexp":"^[a-zA-Z0-9\\._%+-]{1,100}@[a-zA-Z0-9\\.-]{1,40}\\.[a-zA-Z]{1,8}$","type":"string"},"PayerPhone":{"hint":"Payer phone number","regexp":"^.{1,20}$","type":"string"},"BillingCycleStart":{"hint":"The date and time when the payment billing cycle starts.","regexp":"","type":"date"},"BillingCycleEnd":{"hint":"The date and time when the payment billing cycle ends.","regexp":"","type":"date"},"UnsubscribeInstructions":{"hint":"Unsubscribe instructions","regexp":"","type":"string"},"CustomerLoginID":{"hint":"Customer login ID","regexp":"","type":"string"},"PaidAmount":{"hint":"Paid amount","regexp":"","type":"int"},"PaidCurrency":{"hint":"Paid currency","regexp":"^[a-zA-Z]{3}$","type":"string"},"ProviderExchangeRate":{"hint":"Provider exchange rate","regexp":"","type":"float"},"PayerBankAccountID":{"hint":"Payer bank account ID","regexp":"","type":"string"},"IsMobileApp":{"hint":"Payment is initiated in a mobile app","regexp":"","type":"bool"},"IsOffline":{"hint":"Offline payment method","regexp":"","type":"bool"},"StoreName":{"hint":"Store name. Can be null only when the store information is verified","regexp":"","type":"string"},"StoreId":{"hint":"Store ID","regexp":"","type":"string"},"TerminalID":{"hint":"Terminal ID","regexp":"","type":"string"}},"CaptureDetails":{"hint":"","regexp":"","type":"object","ID":{"hint":"Capture ID","regexp":"^\\d{1,12}$","type":"int"},"Amount":{"hint":"Capture amount","regexp":"^\\d{1,12}$","type":"int"},"Status":{"hint":"Preapproval ID","regexp":"","type":"object","ID":{"hint":"Status ID","regexp":"","type":"int"},"Info":{"hint":"The description of the status","regexp":"","type":"string"},"Reasons":{"hint":"The reasons why the payment got to this status.","regexp":"","type":"array of objects","Code":{"hint":"The id of the message type transmitted in the response. See our section GlobalPay Return Codes for a complete description.","regexp":"","type":"int"},"Info":{"hint":"The message body","regexp":"","type":"string"}}}},"ReferenceDetails":{"hint":"Reference details structure","regexp":"","type":"object","BankCode":{"hint":"Customer\u2019s Bank Code. Also known as BIC or Swift_BIC. Bank Identifier Code (BIC), a unique identification code for a particular bank (consists of 8-11 alphanumeric characters).","regexp":"","type":"string"},"BankName":{"hint":"The name of the Bank","regexp":"","type":"string"},"EntityID":{"hint":"Entity ID","regexp":"","type":"string"},"EntityNumber":{"hint":"Entity number","regexp":"","type":"string"},"ReferenceID":{"hint":"Reference ID","regexp":"","type":"string"},"ReferenceNumber":{"hint":"Reference number","regexp":"","type":"string"},"SwiftBIC":{"hint":"Swift Code, a standard format of Bank Identifier Codes (BIC), is a unique identification code for a particular bank (consists of 8-11 alphanumeric characters).","regexp":"","type":"string"},"AccountCurrency":{"hint":"The currency in which the account is kept. Format is according to ISO 4217, a three-letter code.","regexp":"","type":"string"},"AccountNumber":{"hint":"Account number","regexp":"","type":"string"},"AccountHolder":{"hint":"The person whose name is on the bank account.","regexp":"","type":"string"},"IBAN":{"hint":"IBAN (International Bank Account Number) a code (up to 34 alphanumeric characters) that uniquely identifies an account held at any bank anywhere in the world.","regexp":"","type":"string"},"AmountToPay":{"hint":"Amount to be paid","regexp":"","type":"string"},"QRCodeURL":{"hint":"QRCode URL","regexp":"","type":"string"},"BoletoURL":{"hint":"Boleto URL","regexp":"","type":"string"},"Instructions":{"hint":"Payment Instructions","regexp":"","type":"string"}},"CustomParameters":{"hint":"We can collect additional information on the payment flow if you instruct our Support Team to configure this feature for you. The data we gather will be notified in this object.","regexp":"","type":"array"},"PreapprovalID":{"hint":"GlobalPay Preapproval ID, a number that uniquely identifies the preapproval in GlobalPay system. You receive it via a notification and it is used to initiate recurring payments.\r\nFor Cards (69) and Klarna Invoice (75), simply send in this field the initial GlobalPay PaymentID received in the notification of the initial successful one-off payment that the customer has made.","regexp":"^\\d{1,12}$","type":"int"},"Status":{"hint":"Payment status","regexp":"","type":"object","ID":{"hint":"The ID of the payment status. It can have the following values: 1 - Open, 2 - Success, 3 - Cancelled, 4 - Failed, 5 - Expired, 9 - Authorized.","regexp":"","type":"int"},"Info":{"hint":"The description of the status","regexp":"","type":"string"},"Reasons":{"hint":"The reasons why the payment got to this status.","regexp":"","type":"array of objects","Code":{"hint":"The id of the message type transmitted in the response. See our section GlobalPay Return Codes for a complete description.","regexp":"","type":"int"},"Info":{"hint":"The message body","regexp":"","type":"string"}}},"MethodTransactionID":{"hint":"The Acquirer Reference Number (ARN), a unique number that tags a credit card transaction\/refund when it goes from the merchant bank (the acquiring bank) through the card scheme to the cardholder\\'s bank (the issuer). This number can be used by issuing banks to trace a transaction with an acquirer.","regexp":"","type":"string"},"AuthorizationCode":{"hint":"Acquirer Authorization Code","regexp":"","type":"int"},"Capture":{"hint":"If set to true, the payment will be automatically captured.","regexp":"","type":"bool"},"TokenLifetime":{"hint":"The time in minutes after the token used for redirectURL expires. It defaults to 5 minutes if not sent.","regexp":"^\\d{1,12}$","type":"int"},"PaymentTokenLifetime":{"hint":"The time in minutes after the token used for redirectURL expires. It defaults to 5 minutes if not sent.","regexp":"^\\d{1,12}$","type":"int"},"RedirectInIframe":{"hint":"If set true, the payment page will be shown in an Iframe.","regexp":"","type":"bool"},"RedirectMerchantInIframe":{"hint":"Payment redirect in IFrame","regexp":"","type":"bool"},"RedirectURL":{"hint":"GlobalPay redirect URL, an URL where you need to redirect the customer after you receive the response from the API.","regexp":"^(http(s)?(:\\\/\\\/|%3A%2F%2F).+){1,512}$","type":"string"},"PreapprovalDetails":{"hint":"Preapproval details","regexp":"","type":"object","PreapprovedMaximumAmount":{"hint":"Preapproval maximum amount. Please be aware that data type string is also accepted as long as it contains only digits.","regexp":"^\\d{1,12}$","type":"int"},"MerchantPreapprovalID":{"hint":"Preapproval id provided by merchant","regexp":"","type":"string"},"Frequency":{"hint":"Preapproval frequency \u2013 how often can the customer be billed. It can be onetime\/daily\/weekly\/monthly depending on the country and the mobile carrier.","regexp":"","type":"string"},"PreapprovalDescription":{"hint":"Preapproval description","regexp":"","type":"string"}},"InvalidRequestID":{"hint":"If the validation fails and a payment cannot be inserted then an invalid request is inserted in the database and the ID of the newly inserted invalid request is sent to the merchant in the Payment response (in element InvalidRequestID, its value prefixed with \u201di\u201d - to not be confused with the Payment ID).","regexp":"","type":"string"},"StatementDescriptor":{"hint":"Description per transaction that appears on the customer\u2019s billing statement, explaining a charge of the merchant. It helps the customer identify the purchase.","regexp":"","type":"string"},"CreditCardToken":{"hint":"Credit card token structure","regexp":"","type":"object","Value":{"hint":"Token value","regexp":"","type":"string"},"RequireSecurityCode":{"hint":"If set to false when the security code parameter is not used, it will not redirect to the form page to fill in the security code, but the payment will be directly sent to the payment provider.","regexp":"","type":"bool"},"SecurityCode":{"hint":"Token security code","regexp":"","type":"string"}},"Installments":{"hint":"Payment split into installments.\r\nAvailable installments number per country code:\r\nAR: 3, 6, 9, 12;\r\nBR: 2, 3, 4, 5, 6, 10, 12, 15, 18, 24;\r\nCL: 3, 6, 9, 12;\r\nCO: 3, 6, 9, 12, 24, 36;\r\nMX: 3, 6, 9, 12, 18;\r\nPE: 3, 6, 9, 12;\r\nTR: 3, 6, 9, 12.","regexp":"^\\d{1,12}$","type":"int"},"Retry":{"hint":"If set to true, instructs Smart2Pay to retry sending the transaction to the same acquirer (for certain temporary technical errors) or to other acquirers (in case of business errors) according to your account settings.","regexp":"","type":"bool"},"3DSecure":{"hint":"To be set to true for Payments using 3DSecure authentication.","regexp":"","type":"bool"},"3DSecureData":{"hint":"Should contain authentication result obtained from your 3DS MPI Provider.","regexp":"","type":"object","AuthenticationStatus":{"hint":"The authentication status value. Possible values: \\\"Y\\\" = successful,\\\"N\\\" = failed.","regexp":"","type":"string"},"ECI":{"hint":"Electronic Commerce Indicator (ECI) is a value that is returned from the Directory Server (Visa, MasterCard and JCB) to indicate the authentication results of your customer\u2018s credit card payment on 3D Secure. ECI Values for Visa: 05, 06, 07; for Mastercard: 00, 01, 02; for JCB: 05, 06, 07.","regexp":"","type":"string"},"CAVV":{"hint":"The Cardholder Authentication Verification Value (CAVV) is a unique value generated by the issuer (or by Visa on the issuer\u2019s behalf) and is passed on to the acquirer to prove that the transaction has been authenticated. The use of CAVV helps secure the integrity of Verified by Visa (VbV) transactions by enabling end-to-end transaction traceability.","regexp":"","type":"string"},"DSID":{"hint":"The Directory Server unique ID assigned for this payment. This can be used for both 3DSecure v2.0 and 3DSecure v1.0. In 3DSecure v1.0 the parameter is known as XID.","regexp":"","type":"string"},"3DSecureVersion":{"hint":"The protocol version of 3D Secure.","regexp":"","type":"string"}},"DeviceInfo":{"hint":"Provides information regarding the customer\u2018s browser.","regexp":"","type":"object","BrowserAcceptHeader":{"hint":"The accept header value of the customer\u2018s browser. This field is required only if the cardholder\u2018s user agent supplied a value.","regexp":"","type":"string"},"BrowserUserAgent":{"hint":"The user agent value of the customer\u2018s browser.","regexp":"","type":"string"},"BrowserJavaEnabled":{"hint":"Boolean value indicating if the customer\u2018s browser is able to execute Java.","regexp":"","type":"bool"},"BrowserJavaScriptEnabled":{"hint":"Boolean value indicating if the customer\u2018s browser is able to execute JavaScript.","regexp":"","type":"bool"},"BrowserLanguage":{"hint":"The customer\u2018s browser language as defined in IETF BCP 47.","regexp":"","type":"string"},"BrowserColorDepth":{"hint":"Contains a value representing the bit depth of the colour palette, in bits per pixel, for displaying images.","regexp":"","type":"int"},"BrowserScreenHeight":{"hint":"Total height of the customer\u2018s screen in pixels.","regexp":"","type":"int"},"BrowserScreenWidth":{"hint":"Total width of the customer\u2018s screen in pixels.","regexp":"","type":"int"},"BrowserTimeZone":{"hint":"Difference between UTC time and the customer\u2018s browser local time in minutes.","regexp":"","type":"int"}},"ScaExemption":{"hint":"Merchant can explicitly apply for an exemption from SCA sending this parameter. Possible values: LowValueTransaction, TransactionRiskAnalysis, MerchantInitiatedTransaction, TrustedBeneficiary, CorporatePayments.","regexp":"","type":"string"},"CardOnFile":{"hint":"CardOnFile transaction details","regexp":"","type":"object","IsInitial":{"hint":"Must be sent \u201ctrue\u201c when the payment is the first in a subsequent payments chain. Must be sent \u201cfalse\u201c when the payment is not the first in a subsequent payments chain.","regexp":"","type":"bool"},"TransactionType":{"hint":"CardOnFile transactions type. Possible values: Installments, Recurring, Reauthorization, Resubmission, Delayed, Incremental, No Show, Others.","regexp":"","type":"string"},"InitialPaymentID":{"hint":"Initial PaymentID of the payment that generated the CardOnFile. This field must be sent when IsInitial field has the value \u201cfalse\u201c. If the field IsInitial has the value \u201ctrue\u201c, the InitialPaymentID should not be sent, but it will be received in the response.","regexp":"","type":"int"}},"Card":{"hint":"Card details","regexp":"","type":"object","HolderName":{"hint":"The person whose name is on the credit card.","regexp":"^[^\\d]*$","type":"string"},"Number":{"hint":"The number of the credit card","regexp":"^(\\d{16,19})$","type":"string"},"ExpirationMonth":{"hint":"The expiration month of the credit card","regexp":"^(0?[1-9]|1[0-2])$","type":"string"},"ExpirationYear":{"hint":"The expiration year of the credit card","regexp":"^(20|)([0-9]{2})$","type":"string"},"IssuingBankCountry":{"hint":"Card issuing bank country","regexp":"^[a-zA-Z]{2}$","type":"string"},"SecurityCode":{"hint":"The card security code (also called CVV2) consists of a 3 or 4 digit number that appears on the credit card.","regexp":"^([0-9]){3,4}$","type":"string"},"RequireSecurityCode":{"hint":"If set to false when the security code parameter is not used, it will not redirect to the form page to fill in the security code, but the payment will be directly sent to the payment provider.","regexp":"","type":"bool"},"Token":{"hint":"Card token","regexp":"","type":"string"},"MaskedNumber":{"hint":"The card number masked. The last four digits remain unmasked.","regexp":"","type":"string"}},"Fraud":{"hint":"Fraud check structure","regexp":"","type":"object","Status":{"hint":"Fraud check status","regexp":"","type":"string"},"CheckMode":{"hint":"Fraud check mode","regexp":"","type":"string"},"Score":{"hint":"Fraud check score","regexp":"","type":"int"},"Reason":{"hint":"Fraud check reason","regexp":"","type":"string"}},"Moto":{"hint":"If set to true, the payment will be marked at the acquirer as Mail Order Telephone Order type of transaction. This is not available for all acquirers.","regexp":"","type":"bool"}}}

For Card payments the Authorized status can be obtained when a payment is initiated with the Capture parameter set to false.

Request:

POST https://paytest.smart2pay.com/v1/payments/202237/cancel
Authorization: Basic MTAxMDpnYWJp

Response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "Payment": {
    "ID": 202237,
    "ClientIP": null,
    "SkinID": null,
    "Created": "20161205091456",
    "MerchantTransactionID": "s2ptest_h8",
    "OriginatorTransactionID": null,
    "Amount": "2000",
    "Currency": "EUR",
    "CapturedAmount": 0,
    "ReturnURL": "http://demo.smart2pay.com/redirect.php",
    "Description": "payment product",
    "StatementDescriptor": "bank statement message",
    "MethodID": 6,
    "MethodOptionID": null,
    "SiteID": 1010,
    "NotificationDateTime": null,
    "Customer": {
      "ID": 115,
      "MerchantCustomerID": "null",
      "Email": "customer@test.com",
      "FirstName": "John",
      "LastName": "Doe",
      "Gender": "1",
      "SocialSecurityNumber": "45908-28324",
      "Phone": "0744-783322",
      "Company": "S2P"
    },
    "BillingAddress": {
      "ID": 253,
      "City": "Iasi",
      "ZipCode": "7000-49",
      "State": "Iasi",
      "Street": "Sf Lazar",
      "StreetNumber": "37",
      "HouseNumber": "5A",
      "HouseExtension": "-",
      "Country": "RO"
    },
    "ShippingAddress": {
      "ID": 87,
      "City": "Iasi",
      "ZipCode": "700049",
      "State": "Iasi",
      "Street": "Sf Lazar",
      "StreetNumber": "37",
      "HouseNumber": "-",
      "HouseExtension": "-",
      "Country": "RO"
    },
    "Articles": null,
    "Card": null,
    "CreditCardToken": null,
    "Status": {
      "ID": 3,
      "Info": "Cancelled",
      "Reasons": []
    },
    "MethodTransactionID": null,
    "PaymentTokenLifetime": null,
    "Capture": false,
    "Retry": true,
    "RedirectURL": null,
    "3DSecure": null
  }
}

In case of an API error, an HTTP 4xx (you did something wrong) or HTTP 5xx (we did something wrong) response is returned.

For more information about the reasons of a wrong request response see our section GlobalPay Return Codes.

Request:

POST https://paytest.smart2pay.com/v1/payments/3897979/cancel
Authorization: Basic MzAyMDE6aEo1Um9iWXg5cjdGZk53Q3ZIWTlMWEhxcXIrRkV6cmM3YUp2UVFrNEdhejFtZzdSeXk=

Response:

HTTP/1.1 400 Bad Request
Content-Type: application/json; charset=utf-8

{
  "Payment": {
    "ID": 3897979,
    "SkinID": null,
    "ClientIP": null,
    "Created": "20180615091144",
    "MerchantTransactionID": null,
    "OriginatorTransactionID": null,
    "Amount": null,
    "Currency": null,
    "CapturedAmount": null,
    "ReturnURL": null,
    "Description": null,
    "MethodID": 1078,
    "MethodOptionID": null,
    "IncludeMethodIDs": null,
    "ExcludeMethodIDs": null,
    "PrioritizeMethodIDs": null,
    "SiteID": 30201,
    "NotificationDateTime": "20180615091304",
    "Customer": null,
    "BillingAddress": null,
    "ShippingAddress": null,
    "Articles": null,
    "Details": null,
    "ReferenceDetails": null,
    "CustomParameters": null,
    "PreapprovalID": null,
    "Status": {
      "ID": 3,
      "Info": "Cancelled",
      "Reasons": [
        {
        "Code": "17",
        "Info": "Payment is invalid - 3897979"
        }
      ]
    },
    "MethodTransactionID": null,
    "TokenLifetime": null,
    "Capture": null,
    "PreapprovalDetails": null,
    "RedirectURL": null
  }
}