7. Installment Inquiry
Installment Inquiry
Installment Inquiry
GET {{Base Address}}/api/paywall/installment
Sending a request to the address provided above should be sufficient. You can use the 'Base Address' as you wish for both the testing environment and the production environment.
Important: To use the installment inquiry service, you need to send the 'apikeypublic' and 'apiclientpublic' parameters in the 'Header' field.
apikeypublic
string
Yes
The Public Key obtained from the merchant panel.
apiclientpublic
string
Yes
The Public Client obtained from the merchant panel.
currencyid
int
Yes
The currency in which the payment is intended to be made.
See: Currency
amount
decimal
Yes
The amount associated with the payment.
binnumber
string
No
The first 6 digits of the card for which the payment is intended to be made.
distinctduplicates
bool
Yes
In cases where multiple payment providers are used and if you send this parameter as TRUE, the response object will only contain one row for 2 installments even if it is active in multiple providers.
endoftheday
int
No
You can use this to list installments of payment providers (that are connected) with a specific settlement day. Valor Days
posid
int
No
You can use this parameter if you want to list the installments of a specific virtual POS connection.
The response returned from the service:
ErrorCode
int
Error code. It returns a value of '0' if the operation is successful.
Result
bool
It returns either true or false. If the operation is successful, it returns 'true'.
Message
string
If the operation is unsuccessful, this is the message related to the error.
Body
object
It returns 'filled' if the installment option is available, and 'empty' otherwise.
๐ณ The BIN number is the first 6 digits on the card.
Last updated