---
title: "Get payin details"
method: GET
path: "/payins/{id}"
tags: ["Payins"]
---

# Get payin details

`GET /payins/{id}`

## Request

- Base URL: `https://api.enterprise.airtm.com/v2`
- URL: `https://api.enterprise.airtm.com/v2/payins/{id}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/airtm/apis/airtm-enterprise-api-v2/docs/payins/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

Get the details of an existing payin.

## Path parameters

- `id` string, required

## Response `200`

Ok

- PayinResponse: A payin is a transaction that transfers funds from a user's Airtm account to an enterprise's account. Normally, the payin represents a purchase made by a user.
  - `id` string, uuid, required
  - `code` string, required: An arbitrary string of the partner’s choosing. Used to identify and correlate Airtm purchases with partner records. > [!important] > Must be a unique.
  - `hash` string: Unique hash for the payin operation within the Airtm system.
  - `status` 'CREATED' | 'CONFIRMED' | 'CANCELED' | 'PROCESSING' | 'FAILED' | 'BRIDGE_FAILED' | 'BRIDGE_CANCELED', required: The current status of the payin - `CREATED`: The payin has been created but not yet confirmed. - `CONFIRMED`: The payin has been confirmed and is ready for processing. - `CANCELED`: The payin has been canceled by the user or system. - `PROCESSING`: The payin is currently being processed. - `FAILED`: The payin has failed due to an error. - `BRIDGE_FAILED`: The payin has failed due to an error in Bridge. - `BRIDGE_CANCELED`: The payin has been canceled due to an error in Bridge.
  - `amount` number, double, required: Amount in USD that was transacted in the operation.
  - `netAmount` number, double, required: Amount in USD to be received by the enterprise
  - `airtmFee` number, double, required: Amount to be collected by Airtm as fee
  - `description` string, required: A text string describing the purchase. > [!tip] > This text is displayed to the user when they are confirming the transaction.
  - `items` PayinItem[], required: An array of the items being purchased/bought.
    - `description` string, required: An arbitrary string describing the individual item.
    - `amount` number, double, required: The price in USD of the individual item.
    - `quantity` number, double, required: The number of items being purchased. This will be multiplied with the 'amount' value to calculate the total.
    - `id` string, uuid, required: The unique identifier for the item
    - `payinId` string, uuid, required: The unique identifier for the payin.
  - `airtmUserId` string, uuid
  - `airtmUserEmail` string
  - `failureReason` string: If the payin failed to complete, this field will describe why it failed.
  - `createdAt` string, date-time, required: Timestamp of when the payin was created.
  - `updatedAt` string, date-time, required: Timestamp of the last update made to the payin.
  - `confirmationUri` string, url, required: A URL to redirect the user to when they confirm the transaction.
  - `cancelUri` string, url, required: A URL to redirect the user to when they cancel the transaction.

## Other responses

- `default`: Error

---

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