Contents
Within API Logs, you can track every API event that occurs in your system, and the result of each call. To access your API logs, visit this URL, or click on the API Logs link from the left-hand menu on your merchant dashboard. If there isn't any data populating your API Logs page, then no events have occurred.
To learn more about our API in detail, please visit this resource for developers.
Viewing, searching, and filtering API logs
When you have API events occurring between Affirm and your integration of choice, you'll see the events populate here.
You can use the search bar to narrow down results by:
- status
- endpoint
- method
- IP
- request ID
- checkout ID
- charge ID
You can also use the drop-down menu to select a specific time window to view the API events.
You can select between:
- Today
- Yesterday
- Last 7 days
- Last 30 days
- All time
- Custom range
Clicking on an individual event will pull up a detailed look of the event.
You'll see both the API request and response results.
API statuses and endpoints
Each API event is assigned a date (in UTC), status, method, and endpoint. We cover what the status number mean and what the endpoints reference:
|
HTTP response |
Description |
|
200 |
Successful API call |
|
302 |
Customer successfully redirected to Affirm checkout flow [only for Shopify] |
|
40x |
Error: Bad checkout information or incorrect API keys |
|
500 |
Bad request: Incorrect syntax or wrong API URL |
For reference, these are the endpoints.
|
Endpoint |
Description |
|
/checkout/ |
Initiate checkout |
|
/charges/ |
Authorize charge |
|
/charges/<charge_id> |
Read charge details |
|
/charges/<charge_id>/capture |
Capture charge |
|
/charges/<charge_id>/void |
Void charge |
|
/charges/<charge_id>/refund |
Refund charge (full refund unless amount is specified in the response). |
|
/charges/<charge_id>/update |
Change shipping information or order ID. |