API Reference

Authorize a closed loop transaction

post
https://example.com/programs//payments/authorize

Authorizes a closed loop transaction for the specified payment instrument and amount.

Path Params
string
required

The program code identifying the BaaS program context.

Body Params

The request payload containing authorization details.

  • PaymentInstrumentIdentifier: The payment instrument identifier.

  • TransactionAmount: The amount to authorize.

  • Merchant: The merchant details.

  • EncryptedCardData: The encrypted card data.

string | null

The type of message for the payment authorization (e.g., "Authorization", "Advice").

string | null

The identifier of the payment instrument used for the transaction (e.g., card or account number).

encryptedCardData
object

Represents a container for encrypted data used in secure data transfer operations. Contains the encrypted payload and associated cryptographic metadata, including encryption version, ephemeral public key, and public key hash. Used to securely transmit sensitive information such as user data, ensuring confidentiality and integrity during transport.

string | null

The unique identifier for the payment transaction.

string | null

The system trace number for the transaction, used for tracking and reconciliation.

string | null

The transaction code indicating the type of transaction (e.g., purchase, refund).

string | null

The type of account involved in the transaction (e.g., "Checking", "Savings", "Credit").

posEntryMode
object

Represents the point-of-sale entry mode details for a payment transaction. Contains card input, authentication, and terminal capability information.

double | null

The authorized transaction amount.

string | null

The currency code for the transaction (e.g., "USD", "EUR").

double | null

The transaction fee amount, if applicable.

string | null

The transmission date and time of the transaction, formatted as a string.

string | null

The local date and time of the transaction, formatted as a string.

string | null

The settlement date and time for the transaction, formatted as a string.

string | null

The acquiring country code for the transaction.

string | null

The card sequence number, used for multi-card accounts.

string | null

The function code for the transaction, indicating specific processing logic.

int32 | null

The message reason code, used for specific transaction scenarios.

merchant
object

Represents merchant details for a payment transaction. Contains merchant identification, industry, and address information.

double | null

The original transaction amount, used for reversals or adjustments.

string | null

The acquirer identifier for the transaction.

string | null

The retrieval reference number for the transaction, used for audit and dispute purposes.

string | null

The terminal identifier where the transaction was processed.

originalTransactionForReversal
object

Represents the original transaction details for a reversal operation. Contains identifiers and timestamps for the original transaction.

string | null

The e-commerce indicator for the transaction, specifying online or card-not-present status.

Headers
string
required

A unique request identifier for tracking and logging. Should be a GUID.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json

Updated 2 months ago