---
title: "Get purchase"
method: GET
path: "purchases"
tags: ["Purchases / Payins"]
---

# Get purchase

`GET purchases`

## Request

- Base URL: `https://payments.air-pay.io`
- URL: `https://payments.air-pay.io/purchases`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/airtm/apis/airtm-enterprise-api-v1/docs/purchases/get.ts> (a function with typed inputs; its response is checked against the schema)

You can either use this endpoint or the /operations with the ‘type’
parameter as ‘purchase’ in the endpoint to get the list of all
purchases.

## Response `200`

OK

- object
  - `currentPage` number: Page currently displayed.
  - `lastPage` number: Number of pages available.
  - `perPage` number: Number of items per page displayed in the response.
  - `total` number: Total operations retrieved.
  - `from` number: Number of first operation retrieved.
  - `to` number: Number of last operation retrieved.
  - `data` object[]: An array of items retrieved, contains all operations available requested, limited by the 'perPage' parameter.
    - `id` string: Payment unique identifier.
    - `partner_id` string: ID of the partner that created the purchase.
    - `status` string: The status of the operation. Please refer to the Purchases and Payments endpoints to see possible statuses.
    - `amount` string: Amount in USD that was transacted in the operation.
    - `description` string: A text string describing the purchase. This text is displayed to the user when they are confirming the transaction.
    - `confirmation_uri` string: A URL on partner's servers to redirect the user to when they confirm a purchase. For payouts it is deprecated, Airtm no longer calls it.
    - `cancel_uri` string: An available URL on partner's servers to redirect the user to when they cancel a purchase.
    - `code` string: An arbitrary string of the partner’s choosing. Used to identify and correlate Airtm purchases with partner records. Must be a unique.
    - `airtm_operation_id` string: The ID of the operation on Airtm platform.
    - `created_at` string: The datetime the operation was created.
    - `updated_at` string: The datetime the operation was last modified.
    - `airtm_user_id` string: The ID of the user involved in the payout/purchase
    - `airtm_user_email` string: The email of the user involved in the payout/purchase in Airtm.
    - `operation_type` string: Type of operation, will always be 'purchase'.
    - `failure_uri` string: Deprecated. Airtm no longer calls this URL, and new payout requests that include it are rejected. Use webhooks instead.
    - `failure_reason` string: This populates with the reason the operation failed.
    - `callback_uri` string: Deprecated. Airtm no longer calls this URL, and new purchase requests that include it are rejected. Use webhooks instead.
    - `airtm_operation_hash` string: Unique hash for the payout operation within the AirTM system.

## Other responses

- `403`: Forbidden
- `500`: Internal Server Error

---

[API](https://skmtc.dev/airtm/apis/airtm-enterprise-api-v1.md) - [All operations](https://skmtc.dev/airtm/apis/airtm-enterprise-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/airtm/apis/airtm-enterprise-api-v1/revisions/4e8326a04343?raw)