API Reference

Create an authorization request.

put
https://example.com/api/v1/transactions//authorization

This endpoint is used to create a new authorization request.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

A unique transaction identifier. It will be used in all of the subsequent operations on the transaction. The identifier must be unique per merchant.

Body Params

The authorization request

string
required
length between 1 and 64

An identifier that may be used to link authorization with subsequent operations for reconciliation purpose.

string
enum

The source of the transaction. Default value is ECommerce

Allowed:
cardDetails

Represents the payment credentials used for this transaction. This is a polymorphic object whose concrete shape is determined by cardType and may represent a PAN card, network token, or mobile wallet token (Apple Pay or Google Pay). Note that the encrypted contents of this field must be passed in the cardDetailsEncrypted field. All unencrypted card details will be rejected by the API.

string
required
length ≥ 1

This field contains the fields from CardDetails encrypted using the JWE technique specified in the encryption guide.

string | null

Webhook URL that will be called by Cards Connect to deliver notifications about the status of the transaction.

threeDSecureData
object
string | null

This field contains the fields from ThreeDSecureData encrypted using the JWE technique specified in the encryption guide.

string | null

Order id generated by the merchant’s system.

int32
required
1 to 99999999

Amount of the transaction in cents. 1499 is $14.99.

string
required
length between 3 and 3

ISO 4217 currency of the transaction.

statementDescriptor
object

This object that allows the merchant to customise the details of the purchase that will be appear in the cardholder’s statement.

string | null

Cardholder’s id known to the external system, such as merchant’s CRM application.

billingDetails
object

This object contains cardholder’s billing details that might be used by the scheme to verify the transaction. Note that the encrypted contents of this field should be passed in the billingDetailsEncrypted field. An error result if raw card data is included in the request.

string | null

This field contains the fields from BillingDetails encrypted using the JWE technique specified in the encryption guide.

string | null

A scheme's transaction identifier to use in connecting a merchant initiated transaction to the initial customer initiated transaction.

boolean

Indicates whether the transaction represents a subsequent payment coming from a recurring payment setup.

boolean

Indicates whether the transaction was initiated by the merchant (True) or customer (False or omitted).

schemeExtendedRequestData
object
Responses

Updated 3 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/json

Updated 3 months ago