Pay a invoice

POST

/api/v1/invoices/inv_1KMKSTQAVIS00/pay

Request

Header Params

Body Params application/json

Example

{
   "mandate_data":{
       "customer_acceptance":{
        "type":"online"
        ,"accepted_at":"2024-10-06T10:56:21Z"
        ,"online":{
            "ip_address":"192.168.12.1"
            ,"user_agent":"user agent"
            }
        } 
   }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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"
            }
        } 
   }
}'

Responses

🟢200Success

application/json

Body

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

List all invoices

Create a payment method