Integration GuideClient Libraries
API Reference

Authorize payment

post
https://example.com/orders//authorizePayment

The Authorize Payment service is used to process transactions via our API instead of via a hosted payment pages.

👍

Valid payment types

Authorize Payment must be used for the following payment types:

  • Recurring payments
  • Profile payments for MOTO, Merchant Initiated Transactions (No CVC or 3DS) or Direct invoice

Authorize Payment can be used for the following instead of a hosted payment page:

  • Credit Products (Invoice and installments)
  • Swish

HTTP Request

POST /orders/{orderId}/authorizePayment

Request Parameters

PropertyTypeDescription
authorizationType
required		stringExamples: "InvoicePayment", "ProfilePayment", "RecurringPayment", "MobilePayment"
totalAmount
required		decimalThe total amount that should be processed for this payment.

Constraints:

  • Please be sure to use a decimal point as the decimal separator. Commas are not supported.

  • Only two digits may be specified after the decimal point.

  • This must be equal to or less than the original order amount, and less than the original order amount minus any payments which have been already made on the order.

  • For Japanese Yuan (JPY), only whole numbers are allowed.



Example: 125.00
authenticationSessionId
required		guidThe authenticationSessionId is retrieved from a successful authenticationSessionId call. It is a safety meassure to reassure that the consumer has identified properly.
paymentMethodId
conditional		intFor credit products (invoice and installments) set this to 311.


For Swish payments: 126



Conditions:
> Required for credit products (invoice and installments) and mobile payments.
For recurring and profile payments, do not send in this parameter.

Example: 311, 126, 312
transactionId
conditional		string(18)The transaction ID of the initial authorization transaction.

Conditions:
> Only required for recurring payments.

Example: "201412161427444300"
paymentChannelId
conditional		intThe id of the payment channel.

See paymentChannelId page for possible values.

Conditions:
> For recurring payments, this parameter is optional.

Example: 1
routingIndicator
conditional		stringThe name or id of the routing table to use when processing payments.

Conditions:
> This field is used for advanced configurations and should only be provided if asked to do so by Paynova. Providing an invalid value in this field may result in payment failures.

Example: "4658"
paymentMethodProductId
conditional		stringThe payment method product ID for the specific payment type.

Conditions:

> Required for credit products (invoice/installment) orders.

Example: "DirectInvoice", "InstallmentsThreeMonths", "InstallmentsSixMonths", etc.

To see the available paymentMethotProductiId, see the [getPaymentOptions] page (http://api.developers.paynova.com/docs/get-payment-options)
profilePaymentOptions
conditional		ProfilePaymentOptionsConditions:
> Required for profile payments.

Example:
{ "ProfileId": "12345", "ProfileCard": "7FAFC9F1-A1EC-4303-8555-3DF3D910925E" }
urlCallback
conditional		stringThe callback URL for when the payment is completed or cancelled.

Conditions:
> Required for mobile payments.

Example: "https://www.example.com/callback"
mobileTelephone
conditional		stringThe mobile telephone number of the payer.

Constraints:

  • Must be in E.164 format.




Conditions:
> Required for mobile payments.

Example: "+46731234567"

Response Parameters

PropertyTypeDescription
status
optional		statusAPI operation status.

Example:
{ "isSuccess": true, "errorNumber": 0, "statusKey": "SUCCESS", "statusMessage": "The operation was successful.", "errors": null, "exceptionDetails": null }
orderId
conditional		guidPaynova's unique identifier associated with this transaction.

Conditions:
> This parameter is not returned in error situations.

Example: "123456"
transactionId
conditional		string (18)Paynova's unique identifier associated with this transaction. This identifier must be used in subsequent requests to Finalize Authorization and Annul Authorization.

Conditions:
> This parameter is not returned in error situations.

Example: "201602090957016672"
acquirerId
conditional		intID of the settling part.

Conditions:
> This parameter is not returned in error situations.

Example: 1045
acquirerReferenceId
conditional		stringReference ID from the settling part.

Conditions:
> This parameter is not returned in error situations.

Example: "167685"
riskAssessment
conditional		stringReturns the configured mode of the risk assessment and the result. See the RiskAssessment page for possible scenarios.

Example:
{ "mode": "Active", "result":"Approved" }
Language