Get Instrument API
In your exsisting integration this API allows you to fetch customers Amazon Pay balance. Now the scope of this API is enhanced to deliver Amazon Pay latert balance also The API returns payment instruments depending on the request. You can pass instrument type to get the required details. You must display the Amazon Pay Later credit limit and eligibility / ineligibility details to the user on your payments UI. To get the GUI refrences, Please visit the page to find the Refrence here
| Endpoint: | 〈 Domian 〉v1/payments/instruments |
Request query parameters
| Parameter | Type | Description |
|---|---|---|
| merchantId | AuthorizationResponse.Status | Your merchant id provided by Amazon Pay to be used for APL Integration. |
| accessToken | String | Access token fetched for the user as per the current integration. |
| instrumentTypes | String | Payment instrument name for which balance / credit needs to be fetched. AmazonPayLater or AmazonPayBalance |
| amount | String | Transaction amount that customer wants to pay. |
InstrumentType
| Value | Description |
|---|---|
| AmazonPayLater | For fetching the credit limit for AmazonPayLater and eligibility of the user. If customer not eligible we will provide the ineligibility reason. |
| AmazonPayBalance | For fetching Amazon Pay balance of user. |
*Using Sandbox end point you can always get 1000 INR balance and a dummy KFS URL to test the integration.
*Please give option to render KFS URL on the PSP after Amazon Pay later is linked. Reference
Response parameters
| Value | Description |
|---|---|
| AmazonPayLater | This Json name specifies the details in it belongs to Amazon Pay later. |
| enabled | This value will be true if Amazon Pay Later is enabled and false in case customer is ineligible. On receiving false the option needs to be greyed out showing error to the customer. |
| keyFactStatementUrl | Key fact statement notifies customers about their available credit limits and other details. |
| ineligibilityReason | This value notifies the exact reason on why customer is not able to use APL. |
© 2023 - Amazon Pay All Rights Reserved.