---
title: "Retrieve a payment"
method: GET
path: "/billing/v1/payments/{paymentNumber}"
tags: ["Payment"]
---

# Retrieve a payment

`GET /billing/v1/payments/{paymentNumber}`

## Request

- Base URL: `https://marketplace.appdirect.com/api`
- URL: `https://marketplace.appdirect.com/api/billing/v1/payments/{paymentNumber}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/appdirect/apis/companies/docs/billing/v1/payments/:paymentNumber/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a payment given its payment number

## Path parameters

- `paymentNumber` integer, required

## Response `200`

OK

- PaymentWS, nullable: Resource links
  - `links` Link[]: Resource links
    - `href` string
    - `rel` string
  - `amount` number, nullable: Payment amount.
  - `company` LinkWS, nullable
    - `href` string
    - `id` string
  - `currency` 'USD' | 'CAD' | 'EUR' | 'JPY' | 'GBP' | 'KRW' | 'CHF' | 'SEK' | 'SGD' | 'MYR' | 'AUD' | 'MXN' | 'INR' | 'BRL' | 'DKK' | 'NZD' | 'NOK' | 'ZAR' | 'PHP' | 'CNY' | 'SAR' | 'GTQ' | 'IDR' | 'ARS' | 'COP' | 'PEN': Supported currencies for the system
  - `date` number, nullable: Payment date.
  - `gatewayResponse` GatewayResponseWS
    - `avs` boolean: True if address is validated.
    - `code` string, nullable: Code.
    - `cvv` boolean: True if credit card is validated.
    - `message` string, nullable: Message.
  - `id` number, nullable: Payment number.
  - `method` 'CREDIT_CARD' | 'PAYPAL' | 'MANUAL' | 'EXTERNAL_INVOICE' | 'MARKETPLACE_CREDITS': The supported payment methods
  - `result` 'SUCCESSFUL' | 'FAILED' | 'GATEWAY_NOT_AVAILABLE' | 'MANUAL'
  - `transactionId` string, nullable: Transaction ID.
  - `user` LinkWS, nullable
    - `href` string
    - `id` string

## Other responses

- `404`: Not Found

## Changes

- **2026-11-06** `1fc240f06971`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/appdirect/apis/companies/changes/billing/v1/payments/:paymentNumber/get.md)

---

[API](https://skmtc.dev/appdirect/apis/companies.md) - [All operations](https://skmtc.dev/appdirect/apis/companies/llms.txt) - [OpenAPI document](https://skmtc.dev/appdirect/apis/companies/revisions/1fc240f06971?raw)