2. Initiate Payment (By Key)
It is a method you can use to initiate payments with connected APM providers. This method requires an external Key information, which is unique to each provider. You can refer to the list to obtain th
Initiate Payment (Key)
POST {{Base Adres}}/api/paywall/apm/pay/bykey
Important: To use the APM Payment Initiation service, you need to include the 'apikeypublic' and 'apiclientpublic' parameters in the 'Header' section.
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
string
Yes
APM provider key information See: APM
CurrencyId
int
Yes
Currency in which the payment is requested See: Currenc
MerchantUniqueCode
string
Yes
Unique number you created for the payment
MerchantSuccessBackUrl
string
Yes
Address where the successful payment result will be sent receives Post Body response
MerchantFailBackUrl
string
Yes
Address where the successful payment result will be sent receives Post Body response
Amount
decimal
Yes
Payment amount
* If IsRecurring is true this value represents the maximum amount to be charged
Description
string
Yes
Description of the payment Depending on the provider this description may be displayed on the payment screen
IsRecurring
bool
No
If the APM provider supports receiving payment instructions this parameter should be sent as true Supported Provider Masterpass
ExpireDay
int
No
Used if the APM provider supports expiration date on the relevant page or payment flow expects number of days and adds it on top of the current active day Supported Provider Masterpass
IsAutoCommit
bool
No(true)
By default true value is set if you want to change it it should be set as false When true is sent after the 3D process once the payment is completed on the screen the amount is immediately charged from the card
Payer
Payer
Yes
When false is sent after the payment a callback is triggered and then a separate commit request must be sent Object containing the payer information for the payment The required fields within this object may vary depending on the parameters expected by the provider It is recommended to send all information
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
object
If the operation fails this is the error detail object
Last updated