Create an Authorize

post

https://api.tap.company/v2/authorize/

This endpoint authorizes a transaction.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

amount

int32

Defaults to 1

The amount to be authorized in decimal format. (Eg: 3.990)

currency

string

Defaults to KWD

The currency in which the amount should be authorized in standard 3 digit ISO currency code. (Eg: USD)

customer_initiated

boolean

Defaults to true

This parameter determines whether the charge was initiated by customer or not

threeDSecure

boolean

Defaults to true

The 3D Secure request status for a particular authorized payment. Values can either be true or false.

save_card

boolean

Defaults to false

The credit card of the payer can be saved for future transactions. Values can be either true or false.

payment_agreement

object

Serves as a unique identifier for referencing and managing the payment agreement

statement_descriptor

string

The text that appears on the customer's bank/card statement for this charge, e.g., "TAP*SUBSCRIPTION".

receipt

object

Note: This feature is longer supported.

metadata

object

Any additional set of information as key/value pairs to be added to the authorization request. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

reference

object

The reference numbers associated with this authorize request.

customer

object

The customer information.

merchant

object

The ID of the Merchant Account. Available on the Tap Dashboard (goSell > API Credentials > Merchant ID)

source

object

The source of the payment method that needs to be authorized.

authorize_debit

boolean

Defaults to false

A boolean parameter that accepts values true or false. If set to true, the API will process the transaction even if it is not supported by the payment network. It is important to note that currently, this feature is only supported for mada transactions.

auto

object

The type and duration of the authorization.

post

object

The URL to which tap needs to send the response once the authorize is completed.

redirect

object

The URL to which the customer needs to be redirected once the authorize is completed.

payment_provider

object

Information about the payment provider associated with this authorize

Headers

lang_code

string

Defaults to en

change the language in the redirection page to "en" or "ar"

Responses

200200

400400