Class Akbank

Akbank Sanal POS (JSON API, "yeni nesil" sanal POS)

createPayment(): txnCode 1000 (non-3D sale)
initThreeDSPayment(): 3D_PAY model; returns an auto-submitting form to the Akbank securepay gateway. Akbank authenticates and charges, then POSTs the signed result to callbackUrl.
completeThreeDSPayment(): verifies the callback signature and result.
refund() 1002, cancel() 1003, getPayment() 1010 (order history)

Hierarchy (View Summary)

PaymentProvider<AkbankConfig>
- Akbank

Index

Constructors

Methods

authorize binCheck cancel capture completeThreeDSPayment createPayment deleteCard getPayment initThreeDSAuthorize initThreeDSPayment installmentInfo listCards refund saveCard voidAuthorization

Constructors

constructor

new Akbank(config: AkbankConfig): Akbank
Parameters
- config: AkbankConfig
Returns Akbank
Overrides PaymentProvider.constructor
- Defined in packages/better-payment/src/providers/akbank/index.ts:74

Methods

authorize

authorize(request: PaymentRequest): Promise<PaymentResponse>
Pre-authorization (txnCode 1004): blocks the amount without charging it
Parameters
- request: PaymentRequest
Returns Promise<PaymentResponse>
Overrides PaymentProvider.authorize
- Defined in packages/better-payment/src/providers/akbank/index.ts:188

binCheck

binCheck(_binNumber: string): Promise<BinCheckResponse>
Look up a BIN
Parameters
- _binNumber: string
Returns Promise<BinCheckResponse>
Inherited from PaymentProvider.binCheck
- Defined in packages/better-payment/src/core/PaymentProvider.ts:233

cancel

cancel(request: CancelRequest): Promise<CancelResponse>
Void (txnCode 1003). paymentId is the order id.
Parameters
- request: CancelRequest
Returns Promise<CancelResponse>
Overrides PaymentProvider.cancel
- Defined in packages/better-payment/src/providers/akbank/index.ts:437

capture

capture(request: CaptureRequest): Promise<PaymentResponse>
Capture of a pre-authorization (txnCode 1005). amount may be lower than the authorized amount (partial capture).
Parameters
- request: CaptureRequest
Returns Promise<PaymentResponse>
Overrides PaymentProvider.capture
- Defined in packages/better-payment/src/providers/akbank/index.ts:462

completeThreeDSPayment

completeThreeDSPayment(
callbackData: Akbank3DCallbackData,
): Promise<PaymentResponse>
Verifies the okUrl/failUrl POST from Akbank.
1. The HMAC signature must be valid and cover responseCode, orderId and the terminal ids.
2. The signed values are concatenated without a separator, so a signature alone does not pin which value is the orderId. The outcome is therefore confirmed with an order history query (txnCode 1010): a callback whose result does not match Akbank's record for that order is rejected as INVALID_HASH.
Payment succeeded only when the callback and the query both report an approved transaction for the order.
Parameters
- callbackData: Akbank3DCallbackData
Returns Promise<PaymentResponse>
Overrides PaymentProvider.completeThreeDSPayment
- Defined in packages/better-payment/src/providers/akbank/index.ts:338

createPayment

createPayment(request: PaymentRequest): Promise<PaymentResponse>
Non-3D sale (txnCode 1000)
Parameters
- request: PaymentRequest
Returns Promise<PaymentResponse>
Overrides PaymentProvider.createPayment
- Defined in packages/better-payment/src/providers/akbank/index.ts:183

deleteCard

deleteCard(_request: DeleteCardRequest): Promise<DeleteCardResponse>
Deletes a saved card
Parameters
- _request: DeleteCardRequest
Returns Promise<DeleteCardResponse>
Inherited from PaymentProvider.deleteCard
- Defined in packages/better-payment/src/core/PaymentProvider.ts:200

getPayment

getPayment(paymentId: string): Promise<PaymentResponse>
Query a payment
Parameters
- paymentId: string
Returns Promise<PaymentResponse>
Overrides PaymentProvider.getPayment
- Defined in packages/better-payment/src/providers/akbank/index.ts:512

initThreeDSAuthorize

initThreeDSAuthorize(
request: ThreeDSPaymentRequest & { failUrl?: string },
): Promise<ThreeDSInitResponse>
3D Secure pre-authorization (txnCode 3004, 3D_PAY). The bank posts the result to callbackUrl; completeThreeDSPayment() verifies it as usual.
Parameters
- request: ThreeDSPaymentRequest & { failUrl?: string }
Returns Promise<ThreeDSInitResponse>
Overrides PaymentProvider.initThreeDSAuthorize
- Defined in packages/better-payment/src/providers/akbank/index.ts:255

initThreeDSPayment

initThreeDSPayment(
request: ThreeDSPaymentRequest & { failUrl?: string },
): Promise<ThreeDSInitResponse>
3D Secure payment (3D_PAY model)

Returns an auto-submitting HTML form to the Akbank gateway. Card data is posted from the customer's browser directly to Akbank.
Parameters
- request: ThreeDSPaymentRequest & { failUrl?: string }
Returns Promise<ThreeDSInitResponse>
Overrides PaymentProvider.initThreeDSPayment
- Defined in packages/better-payment/src/providers/akbank/index.ts:245

installmentInfo

installmentInfo(
_request: InstallmentInfoRequest,
): Promise<InstallmentInfoResponse>
Not available: Akbank's Sanal POS API has no installment-rate query. Installment plans come from your Akbank agreement; send installment in the payment request and set paidPrice from your contracted rates.
Parameters
- _request: InstallmentInfoRequest
Returns Promise<InstallmentInfoResponse>
Overrides PaymentProvider.installmentInfo
- Defined in packages/better-payment/src/providers/akbank/index.ts:504

listCards

listCards(_request: { customerToken: string }): Promise<ListCardsResponse>
A customer's saved cards
Parameters
- _request: { customerToken: string }
Returns Promise<ListCardsResponse>
Inherited from PaymentProvider.listCards
- Defined in packages/better-payment/src/core/PaymentProvider.ts:195

refund

refund(request: RefundRequest): Promise<RefundResponse>
Refund (txnCode 1002). paymentId is the order id.
Parameters
- request: RefundRequest
Returns Promise<RefundResponse>
Overrides PaymentProvider.refund
- Defined in packages/better-payment/src/providers/akbank/index.ts:407

saveCard

saveCard(_request: SaveCardRequest): Promise<SaveCardResponse>
Saves a card with the provider without charging it
Parameters
- _request: SaveCardRequest
Returns Promise<SaveCardResponse>
Inherited from PaymentProvider.saveCard
- Defined in packages/better-payment/src/core/PaymentProvider.ts:190

voidAuthorization

voidAuthorization(request: VoidAuthorizationRequest): Promise<CancelResponse>
Releases a pre-authorization: Akbank voids it like any other transaction (txnCode 1003)
Parameters
- request: VoidAuthorizationRequest
Returns Promise<CancelResponse>
Overrides PaymentProvider.voidAuthorization
- Defined in packages/better-payment/src/providers/akbank/index.ts:492

Class Akbank

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Akbank

Methods

authorize

Parameters

Returns Promise<PaymentResponse>

binCheck

Parameters

Returns Promise<BinCheckResponse>

cancel

Parameters

Returns Promise<CancelResponse>

capture

Parameters

Returns Promise<PaymentResponse>

completeThreeDSPayment

Parameters

Returns Promise<PaymentResponse>

createPayment

Parameters

Returns Promise<PaymentResponse>

deleteCard

Parameters

Returns Promise<DeleteCardResponse>

getPayment

Parameters

Returns Promise<PaymentResponse>

initThreeDSAuthorize

Parameters

Returns Promise<ThreeDSInitResponse>

initThreeDSPayment

Parameters

Returns Promise<ThreeDSInitResponse>

installmentInfo

Parameters

Returns Promise<InstallmentInfoResponse>

listCards

Parameters

Returns Promise<ListCardsResponse>

refund

Parameters

Returns Promise<RefundResponse>

saveCard

Parameters

Returns Promise<SaveCardResponse>

voidAuthorization

Parameters

Returns Promise<CancelResponse>

Settings

On This Page