UseePay Open API
UseePay Portal
Product Docs
  • V2.0
  • V1.0
Mechant Dashboard
UseePay Portal
Product Docs
  • V2.0
  • V1.0
Mechant Dashboard
  1. Invoices
  • Intergration
    • About Payment Methods
      • Card
      • Apple Pay
      • Google Pay
      • Klarna
      • Naver pay
      • Kakao Pay
      • Toss Pay
      • Payco
      • Affirm
    • subscription
      • Get started with Subscription
    • online payment
      • Get started with online payments
    • Payment Capabilities
      • Adaptive Price
  • developer
    • Introduction
    • Authentication
    • Errors
    • error code
      • last_payment_error documentation
    • Best Integration
      • Quickly create a paymentIntent for a subscription
      • Auto-Charge Subscription Guide
    • Payment Intents
      • Payment Intent Overview
      • Quickly create a paymentIntent
      • Create a PaymentIntent
      • Retrieve a PaymentIntent
      • Update a PaymentIntent
      • Confirm a PaymentIntent
      • Cancel a PaymentIntent
      • Capture a PaymentIntent
      • List all payment intents
    • Customers
      • Create a customer
      • Retrieves a customer
      • Update a customer
      • List all customers
    • Subscriptions
      • Create a subscription
      • Retrieves a subscription
      • Update a subscription
      • List all subscriptions
      • Cancel a subscription
    • Invoices
      • Create a invoice
        POST
      • Retrieves a invoice
        GET
      • 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
      • List all mandates
    • Refunds
      • Create a refund
      • Retrieves a refund
      • List all refunds
    • Webhooks
      • Webhook events
      • Webhook Activation/Signature Verification Steps
      • Create a webhook
      • Retrieves a webhook
      • Update a webhook
      • List all webhooks
    • Embedded Checkout
      • Payment Elements
    • case
    • objects
    • About Testing
      • Test Cards
      • ApplePay&GooglePay
  • message
    • Messaging Element
  • FAQ
    • Unable to receive Webhook notifications
  1. Invoices

Pay a invoice

Useepay API V2.0 Sandbox Environment
https://openapi1.uat.useepay.com
Useepay API V2.0 Sandbox Environment
https://openapi1.uat.useepay.com
POST
/api/v1/invoices/inv_1KMKSTQAVIS00/pay

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://openapi1.uat.useepay.com/api/v1/invoices/inv_1KMKSTQAVIS00/pay' \
--header 'x-merchant-no: 500000000007245' \
--header 'x-api-key: FUYTIUvjhgfytfuytwiue' \
--header 'x-app-id: www.pay.com' \
--header 'Content-Type: application/json' \
--data-raw '{
   "mandate_data":{
       "customer_acceptance":{
        "type":"online"
        ,"accepted_at":"2024-10-06T10:56:21Z"
        ,"online":{
            "ip_address":"192.168.12.1"
            ,"user_agent":"user agent"
            }
        } 
   }
}'
Response Response Example
{
    "id": "inv_1JBQUCEC40000",
    "code": null,
    "source": null,
    "message": "E11000 duplicate key error collection: audit.payment_intent index: customer.customer_mid_idx dup key: { : null, : null, : null }",
    "currency": "JPY",
    "description": "invoice desc update1",
    "metadata": {
        "youid": "your param"
    },
    "status": "payment_failed",
    "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:32:19Z",
    "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-03-24 02:23:06
Previous
List all invoices
Next
Create a payment method
Built with