Skip to main content
POST
Authorisation Request API

Body

application/json
card
object
required

Information about the card used for the payment.

merchant
object
required
transaction
transaction · object
required
id
string<uuid>

Unique system generated ID assigned to each event in the payment processing workflow. For example, an ID assigned to the initial authorisation event.

transactionId
string<uuid>

Enfuce generated unique ID assigned to each card transaction. Transaction events for the same card payment includes the same transactionId. For example, authorisation, incremental authorisation, and adjustment for the same transaction includes the same transactionID.

messageCategory
enum<string>

Message category sent in the authorisation control webhook. Possible enums:

  • INITIAL_AUTHORIZATION: Initial authorisation of the card payment.
  • INCREMENTAL_AUTHORIZATION: Additional authorisation for a previously authorised transaction.
  • BALANCE_INQUIRY: Enquiring about the current balance of the funding account from the external application.
  • PIN_MANAGEMENT: Request to change the card PIN.
Available options:
INITIAL_AUTHORIZATION,
INCREMENTAL_AUTHORIZATION,
BALANCE_INQUIRY,
PIN_MANAGEMENT
messageFunction
enum<string>

Identifies the message function of the authorisation request.

Available options:
REQUEST
token
object

Information about the token associated with the card.

Response

200 - application/json
authResponseCode
enum<string>
required

Indicates whether the authorisation request is approved or declined. Possible enums:

  • APPROVED - Approved
  • PARTIALLY_APPROVED - Approved for partial amount
  • DO_NOT_HONOR - Do not honor (Note: Card schemes recommend to use this only when other options do not apply)
  • NOT_SUFFICIENT_FUNDS - Inadequate funds
  • NOT_PERMITTED - Transaction not permitted to cardholder
  • EXCEEDS_AMOUNT_LIMIT - Exceeds approval amount limit
  • RESTRICTED_CARD - Restricted card (card invalid in region or country)
  • EXCEEDS_WITHDRAWAL_FREQUENCY_LIMIT - Exceeds withdrawal frequency limit
  • SYSTEM_ERROR - System malfunction
Available options:
APPROVED,
PARTIALLY_APPROVED,
DO_NOT_HONOR,
NOT_SUFFICIENT_FUNDS,
NOT_PERMITTED,
EXCEEDS_AMOUNT_LIMIT,
RESTRICTED_CARD,
EXCEEDS_WITHDRAWAL_FREQUENCY_LIMIT,
SYSTEM_ERROR
account
object
partialApprovalAmount
money · object

Return when there is a partial approval. When the balance is less than the transaction amount, return the available amount that you authorise. Return this attribute only when in the request merchant.partialApprovalCapable is true (i.e. the merchant approves that a smaller amount than the full transaction amount is authorised), and authResponseCode should be PARTIALLY_APPROVED.