> This page is for Afterpay Online Developer, version v1. > For other versions, use one of these documentation indexes: > - Main (default): https://developers.afterpay.com/afterpay-online-developer/main/llms.txt > - v1: https://developers.afterpay.com/afterpay-online-developer/v-1/llms.txt > - Chinese: https://developers.afterpay.com/afterpay-online-developer/chinese/llms.txt > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developers.afterpay.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.afterpay.com/_mcp/server. # List Payments GET https://global-api-sandbox.afterpay.com/v1/payments/environment:{environment} This endpoint retrieves a collection of payments along with their order details. ### Connection Timeouts | Timeout | Time (Seconds) | | ------- | ------------ | | Open | 10 | | Read | 20 | Reference: https://developers.afterpay.com/afterpay-online-developer/api-reference/reference/payments/list-payments ## Authentication - `Authorization` header (basic auth, required) — Basic authentication of the form `Basic `. ## Request ### Path parameters - `environment` (string, required) — Use `api-sandbox` for AU/NZ, or `api.us-sandbox` for US. ### Query parameters - `toCreatedDate` (string, optional) — An inclusive end date and time to search, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format. - `fromCreatedDate` (string, optional) — An inclusive start date and time to search, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format. - `limit` (integer, optional, default: 20) — The number of results to retrieve. Must be between 1 and 250 (inclusive). - `offset` (integer, optional, default: 0) — The position to start the results at. The first result has a position of 0. - `tokens` (list of string, optional) — One or more order tokens to search for. - `ids` (list of string, optional) — One or more Afterpay Order IDs to search for. - `merchantReferences` (list of string, optional) — One or more Merchant Reference IDs to search for. - `statuses` (list of string, optional) — One or more Afterpay Order Statuses to search for. Possible values include "APPROVED" and "DECLINED". - `orderBy` (string, optional, default: createdAt) — A field to order results by. If provided, must be one of "createdAt", "id", "totalAmount", "merchantReference" or "email". - `ascending` (boolean, optional, default: false) — `true` to order results in ascending order, or `false` for descending order. ### Headers - `Accept` (string, optional, default: application/json) ## Response ### 200 Returns the matching Payment objects, enclosed in a Pagination object. ## Errors ### 422 Unprocessable Entity Error An invalid query param was provided. For example, a value for `limit` was provided, but was less than 1 or more than 250. - `any` ### 500 Internal Server Error This is usually caused by sending a fromCreatedDate or toCreatedDate in an invalid format. Please ensure the dash and colon characters are included, and any plus characters are URL-encoded. Also, for the array parameters (`ids`, `tokens`, `merchantReferences` and `statuses`), do not use comma-separated values or square brackets. Instead, include each parameter multiple times, as needed. - `any` ## Examples **Request** ```json {} ``` **Response** ```json { "payments": [ { "id": "aporder_9876543210fedcba", "token": "ord_1234567890abcdef", "merchantReference": "merchant-ref-001", "status": "APPROVED", "createdAt": "2024-06-15T12:34:56Z", "totalAmount": { "amount": 150, "currency": "AUD" }, "orderDetails": { "items": [ { "name": "Wireless Headphones", "sku": "WH-1000XM4", "quantity": 1, "price": { "amount": 150, "currency": "AUD" } } ], "customer": { "email": "customer@example.com", "firstName": "Jane", "lastName": "Doe" } } }, { "id": "aporder_1234567890abcdef", "token": "ord_abcdef1234567890", "merchantReference": "merchant-ref-002", "status": "DECLINED", "createdAt": "2024-06-10T09:20:30Z", "totalAmount": { "amount": 75.5, "currency": "AUD" }, "orderDetails": { "items": [ { "name": "Bluetooth Speaker", "sku": "BS-500", "quantity": 1, "price": { "amount": 75.5, "currency": "AUD" } } ], "customer": { "email": "john.smith@example.com", "firstName": "John", "lastName": "Smith" } } } ], "pagination": { "limit": 20, "offset": 0, "total": 2 } } ``` **SDK Code** ```python import requests url = "https://global-api-sandbox.afterpay.com/v1/payments/environment:api-sandbox" querystring = {"toCreatedDate":"2024-06-30T23:59:59Z","fromCreatedDate":"2024-06-01T00:00:00Z","limit":"20","offset":"0","tokens":"[\"ord_1234567890abcdef\"]","ids":"[\"aporder_9876543210fedcba\"]","merchantReferences":"[\"merchant-ref-001\"]","statuses":"[\"APPROVED\",\"DECLINED\"]","orderBy":"createdAt","ascending":"false"} payload = {} headers = { "User-Agent": "Afterpay Online API Simulator", "Accept": "application/json" "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers, params=querystring, auth=("", "")) print(response.json()) ``` ```javascript const url = 'https://global-api-sandbox.afterpay.com/v1/payments/environment:api-sandbox?toCreatedDate=2024-06-30T23%3A59%3A59Z&fromCreatedDate=2024-06-01T00%3A00%3A00Z&limit=20&offset=0&tokens=%5B%22ord_1234567890abcdef%22%5D&ids=%5B%22aporder_9876543210fedcba%22%5D&merchantReferences=%5B%22merchant-ref-001%22%5D&statuses=%5B%22APPROVED%22%2C%22DECLINED%22%5D&orderBy=createdAt&ascending=false'; const credentials = btoa(":"); const options = { method: 'GET', headers: { 'User-Agent': 'Afterpay Online API Simulator', Accept: 'application/json', Authorization: `Basic ${credentials}`, 'Content-Type': 'application/json' }, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://global-api-sandbox.afterpay.com/v1/payments/environment:api-sandbox?toCreatedDate=2024-06-30T23%3A59%3A59Z&fromCreatedDate=2024-06-01T00%3A00%3A00Z&limit=20&offset=0&tokens=%5B%22ord_1234567890abcdef%22%5D&ids=%5B%22aporder_9876543210fedcba%22%5D&merchantReferences=%5B%22merchant-ref-001%22%5D&statuses=%5B%22APPROVED%22%2C%22DECLINED%22%5D&orderBy=createdAt&ascending=false" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("User-Agent", "Afterpay Online API Simulator") req.Header.Add("Accept", "application/json") req.SetBasicAuth("", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://global-api-sandbox.afterpay.com/v1/payments/environment:api-sandbox?toCreatedDate=2024-06-30T23%3A59%3A59Z&fromCreatedDate=2024-06-01T00%3A00%3A00Z&limit=20&offset=0&tokens=%5B%22ord_1234567890abcdef%22%5D&ids=%5B%22aporder_9876543210fedcba%22%5D&merchantReferences=%5B%22merchant-ref-001%22%5D&statuses=%5B%22APPROVED%22%2C%22DECLINED%22%5D&orderBy=createdAt&ascending=false") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["User-Agent"] = 'Afterpay Online API Simulator' request["Accept"] = 'application/json' request.basic_auth("", "") request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://global-api-sandbox.afterpay.com/v1/payments/environment:api-sandbox?toCreatedDate=2024-06-30T23%3A59%3A59Z&fromCreatedDate=2024-06-01T00%3A00%3A00Z&limit=20&offset=0&tokens=%5B%22ord_1234567890abcdef%22%5D&ids=%5B%22aporder_9876543210fedcba%22%5D&merchantReferences=%5B%22merchant-ref-001%22%5D&statuses=%5B%22APPROVED%22%2C%22DECLINED%22%5D&orderBy=createdAt&ascending=false") .header("User-Agent", "Afterpay Online API Simulator") .header("Accept", "application/json") .basicAuth("", "") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://global-api-sandbox.afterpay.com/v1/payments/environment:api-sandbox?toCreatedDate=2024-06-30T23%3A59%3A59Z&fromCreatedDate=2024-06-01T00%3A00%3A00Z&limit=20&offset=0&tokens=%5B%22ord_1234567890abcdef%22%5D&ids=%5B%22aporder_9876543210fedcba%22%5D&merchantReferences=%5B%22merchant-ref-001%22%5D&statuses=%5B%22APPROVED%22%2C%22DECLINED%22%5D&orderBy=createdAt&ascending=false', [ 'body' => '{}', 'headers' => [ 'Accept' => 'application/json', 'Content-Type' => 'application/json', 'User-Agent' => 'Afterpay Online API Simulator', ], 'auth' => ['', ''], ]); echo $response->getBody(); ``` ```csharp using RestSharp; using RestSharp.Authenticators; var client = new RestClient("https://global-api-sandbox.afterpay.com/v1/payments/environment:api-sandbox?toCreatedDate=2024-06-30T23%3A59%3A59Z&fromCreatedDate=2024-06-01T00%3A00%3A00Z&limit=20&offset=0&tokens=%5B%22ord_1234567890abcdef%22%5D&ids=%5B%22aporder_9876543210fedcba%22%5D&merchantReferences=%5B%22merchant-ref-001%22%5D&statuses=%5B%22APPROVED%22%2C%22DECLINED%22%5D&orderBy=createdAt&ascending=false"); client.Authenticator = new HttpBasicAuthenticator("", ""); var request = new RestRequest(Method.GET); request.AddHeader("User-Agent", "Afterpay Online API Simulator"); request.AddHeader("Accept", "application/json"); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let credentials = Data(":".utf8).base64EncodedString() let headers = [ "User-Agent": "Afterpay Online API Simulator", "Accept": "application/json", "Authorization": "Basic \(credentials)", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://global-api-sandbox.afterpay.com/v1/payments/environment:api-sandbox?toCreatedDate=2024-06-30T23%3A59%3A59Z&fromCreatedDate=2024-06-01T00%3A00%3A00Z&limit=20&offset=0&tokens=%5B%22ord_1234567890abcdef%22%5D&ids=%5B%22aporder_9876543210fedcba%22%5D&merchantReferences=%5B%22merchant-ref-001%22%5D&statuses=%5B%22APPROVED%22%2C%22DECLINED%22%5D&orderBy=createdAt&ascending=false")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```