UseePay API
  1. Invoices
UseePay API
  • Introduction
  • Product Overview
  • Authentication
  • Errors
  • Changelog
  • Integration
    • Get started with online payments
    • Get started with subscriptions
  • Payment Intents
    • Create a PaymentIntent
      POST
    • Retrieve a PaymentIntent
      GET
    • Update a PaymentIntent
      POST
    • Confirm a PaymentIntent
      POST
    • Cancel a PaymentIntent
      POST
    • Capture a PaymentIntent
      POST
    • List all payment intents
      GET
  • Customers
    • Create a customer
      POST
    • Retrieves a customer
      GET
    • Update a customer
      POST
    • List all customers
      GET
  • Subscriptions
    • Create a subscription
      POST
    • Retrieves a subscription
      GET
    • Update a subscription
      POST
    • List all subscriptions
      GET
    • Cancel a subscription
      POST
  • Invoices
    • Create a invoice
      POST
    • Retrieves a invoice
      GET
    • Update a invoice
      POST
    • List all invoices
      GET
    • Pay a invoice
      POST
  • Payment Methods
    • Create a payment method
    • Retrieves a payment method
    • Update a payment method
    • List all payment methods
  • Mandates
    • Create a mandate
    • Retrieves a mandate
    • Update a mandate
    • List all mandates
  • Refunds
    • Create a refund
    • Retrieves a refund
    • Update a refund
    • List all refunds
  • Webhooks
    • Webhook envents
    • Create a webhook
    • Retrieves a webhook
    • Update a webhook
    • List all webhooks
  • Payment Links
    • Create a payment link
    • Retrieves a payment link
    • Update a payment link
    • List all payment links
  • Embedded Checkout
    • Payment Elements
  • About Testing
    • Test Cards
    • ApplePay&GooglePay
  1. Invoices

Retrieves a invoice

GET
/api/v1/invoices/{{invoice-id}}

Request

Header Params

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://openapi1.uat.useepay.com/api/v1/invoices/inv_1JBQUCEC40000' \
--header 'x-merchant-no: 500000000007245' \
--header 'x-api-key: FUYTIUvjhgfytfuytwiue' \
--header 'x-app-id: www.pay.com'

Responses

🟢200Success
application/json
Body

Example
{
    "id": "inv_1JBQUCEC40000",
    "code": null,
    "source": null,
    "message": null,
    "currency": "JPY",
    "description": "invoice desc",
    "metadata": {
        "youid": "your param"
    },
    "status": "open",
    "footer": "Footer to be displayed on the invoice",
    "number": "invoicenum000000001",
    "merchant_no": "500000000007264",
    "app_id": "www.pay.com",
    "create_at": "2024-10-28T07:28:18Z",
    "modify_at": "2024-10-28T07:28:18Z",
    "decline_code": null,
    "doc_url": null,
    "collection_method": "charge_automatically",
    "customer_id": "cus_1JA7UDDQG3800",
    "hosted_invoice_url": null,
    "payment_intent": null,
    "period_end": null,
    "period_start": null,
    "subscription_id": "sub_1JBQUBE5K0000",
    "total_amount": 112
}
Modified at 2025-01-14 05:31:32
Previous
Create a invoice
Next
Update a invoice
Built with