1. Create Payment
It's a method used to initiate payments with connected APM providers (QR-based). Through this method, payments are facilitated by displaying a QR code to users for scanning and completing transactions
Initiate Payment / QR-Based
POST {{Base Adres}}/api/paywall/apm/pay/qr/generate
Important: To use the APM Initiate Payment (QR-Based) service, you need to include the 'apikeypublic' and 'apiclientpublic' parameters in the 'Header' field.
The headers parameters that need to be sent to the service are as follows:
apikeypublic
string
Yes
The Public Key obtained from the merchant panel.
apiclientpublic
string
Yes
The Public Client obtained from the merchant panel.
The parameters that need to be sent to the service in the BODY are as follows:
ApmKey
int
Yes (Conditional)
The Key information of the APM provider.
Bkz: APM
ApmConnectionId
int
Yes (Conditional)
It is the Id (identifier) information obtained from the APM listing service connections. In scenarios where you dynamically generate your payment screen, you can initiate payments through the relevant connection using this parameter.
CurrencyId
int
Yes
The currency in which the payment is to be processed. Bkz: Currencies
MerchantUniqueCode
string
Yes
The unique identifier generated for the payment.
Amount
decimal
Yes
The payment amount
Description
string
Yes
Description of the payment. Depending on the provider, this description may be displayed on the payment screen.
Provider
object
No
This is used when there are specific information requirements from the provider. It is not currently active for QR-based payments and can be passed as null.
UserRedirectUrl
string
No
This is the address provided for redirection in wallet applications where scanning the QR code and successful payment may lead the user.
MerchantSuccessBackUrl
string
Yes
This is the address where the successful result of the payment will be reported via POST.
MerchantFailBackUrl
string
Yes
This is the address where the unsuccessful result of the payment will be reported via POST.
Payer
Fullname
string
Yes (Conditional)
Payer full name
CardNumber
string
Yes (Conditional)
Payer card number (e.g., meal card, etc.)
CardId
string
Yes (Conditional)
Payer card identity number (works if stored in the APM provider)
Phone
string
Yes (Conditional)
Payer phone number
string
Yes (Conditional)
Payer email address
UserIdentity
string
Yes (Conditional)
Payer identity information in your system (TCKN/VKN)
ConsumerIdentity
string
Yes (Conditional)
Payer identity information in your system (UserId)
Birthday
DateTime
No
Payer date of birth
CardAlias
string
Yes (Conditional)
Label of the card belonging to the payer (Masterpass)
A sample JSON to be sent to the service is as follows:
The parameters returned from the service are as follows:
ErrorCode
int
Error code. Returns '0' if the operation is successful
Result
bool
Returns true or false. If the operation is successful, it returns 'true'
Message
string
If the operation fails, this is the message describing the error, with language support based on the locale parameter
Body
nesne
If the operation fails, this is the error detail object
Body:FormatType
int
Indicates the format of the QRr See: Formats
Last updated