Shopping Loan Application

URL

The endpoint and http method information to initialize Shopping loan application.

POST/payment/v1/bnpl-payments/init

Request Parameters

apmType

string

required

Shopping Loan Provider

Values:

MASLAK

ALFABANK

TOM_FINANCE

HASO

PAYCELL

merchantApmId

number

ID of Alternative Payment Method which is declared in APM Management Page of Merchant Panel. It is recommended to sent if multiple APM declared in same APM Type.

conversationId

string

"boomerang" value that can be sent with the request and received with the response. It can be used to associate different requests with each other. Usually, the order number is used that is stored in merchant own system.

externalId

string

It is generally used as a payment order number or basket number on the merchant side. You can search with this value later by using reporting services.

price

decimal

required

Total basket price. The sum of the item prices in the basket must be equal to total basket price.

paidPrice

decimal

required

The final amount to be paid from the card by calculating differences such as commissions and discounts. The amount to be collected from the wallet is also included in this amount. If there is an interest in the transaction, the amount with the interest added should be entered in this parameter.

buyerMemberId

number

ID of the buyer that is returned from member creation.

currency

Currency

required

See: Currency

Values:

TRY

KZT

paymentGroup

PaymentGroup

required

See: Payment Groups

Values:

PRODUCT

LISTING_OR_SUBSCRIPTION

paymentChannel

string

It is generally used to keep information specific to the payment channel on the merchant side. You can search with this value later by using reporting services.

callbackUrl

string

The URL to be used to send the result returned from the APM to the merchant

apmOrderId

string

Order id parameter to be transmitted to the APM when receiving the payment. Since it is optional, it is recommended not to send it and the orderId value is generated by Craftgate.

apmUserIdentity

string

Unique user id that is given from Altervative Payment Provider's system

additionalParams

map<string, map>

Additional parameters related to payment.

clientIp

string

IP of the buyer.

items

PaymentItem[]

required

Payment items related to payment. You must send at least one payment item and the sum of prices must be equal to the price field.

bankCode

string

required

Bank code of shopping loan application

cartItems

BnplPaymentCartItem[]

required

Shopping loan basket itemsYou must send at least one payment item and the sum of prices must be equal to the price field.

Response Parameters

Parameters returned as a result of request are also subject to the rules specified in the Response Formats section of the API documentation home page. In the absence of a systematic or fictional error, the sub-parameters of the object returned in the data parameter are as follows:

paymentId

number

Payment Id

paymentStatus

PaymentStatus

Represent payment status

Values:

FAILURE

SUCCESS

INIT_THREEDS

CALLBACK_THREEDS

WAITING

additionalAction

AdditionalAction

While some APM integrations may require extra operations, in others this process is not required. In cases where NONE is returned, there is no need to take any extra action for APM payment. See: APM Additional Actions

Values:

REDIRECT_TO_URL

NONE

redirectUrl

string

Redirect URL of the APM

paymentError

PaymentError

Detail information of the error, if the payment received an error.

Sample Codes

You can review the sample codes in the open source Craftgate API clients.

Java.NETPHPNode.jsGo

Loading..