v1

latestOpenAPI 3.0.12026-07-243407211.3 MB

Payment

Authorize a closed loop transaction

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

post/programs/{programCode}/payments/authorize

Path parameters

programCodestring required

The program code identifying the BaaS program context.

Headers

X-GD-RequestIdstring required

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

Request body

messageTypestring nullable

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

paymentInstrumentIdentifierstring nullable

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

transactionIdentifierstring nullable

The unique identifier for the payment transaction.

systemTraceNumberstring nullable

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

transactionCodestring nullable

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

accountTypestring nullable

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

transactionAmountnumber double nullable

The authorized transaction amount.

transactionCurrencystring nullable

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

transactionFeeAmountnumber double nullable

The transaction fee amount, if applicable.

transmissionDateTimestring nullable

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

localDateTimestring nullable

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

settlementDateTimestring nullable

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

acquiringCountryCodestring nullable

The acquiring country code for the transaction.

cardSequenceNumberstring nullable

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

functionCodestring nullable

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

messageReasonCodeinteger nullable

The message reason code, used for specific transaction scenarios.

originalAmountnumber double nullable

The original transaction amount, used for reversals or adjustments.

acquirerIdstring nullable

The acquirer identifier for the transaction.

retrievalReferenceNumberstring nullable

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

terminalIdentifierstring nullable

The terminal identifier where the transaction was processed.

eCommerceIndicatorstring nullable

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

Response

messageTypestring nullable

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

paymentInstrumentIdentifierstring nullable

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

transactionIdentifierstring nullable

The unique identifier for the payment transaction.

systemTraceNumberstring nullable

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

retrievalReferenceNumberstring nullable

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

transactionAmountnumber double nullable

The authorized transaction amount.

transactionCurrencystring nullable

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

approvalCodestring nullable

The approval code returned by the payment network or processor.

actionCodestring nullable

The action code indicating the result of the authorization (e.g., "00" for approved, "05" for declined).

additionalAmountnumber double nullable

Any additional amount authorized or related to the transaction (e.g., cashback).