🧾Invoices

Charges are used to process the payments from a payment intent same as normal invoices.

List an Invoice

GET https://api.turinpay.com/invoice

This endpoint list all invoice created by the user instance

Headers

Name	Type	Description
X-API-Key	string	Authentication token from the API key belonging to the user

200 Returns a list of invoices created by the user

{
    "id": "f16f02a4d526a7a7d4701335cdfa36add5e668809d8b49d9a9d1f1d4ab5ff3b4",
    "status": "CONFIRMED",
    "customerId": 3,
    "description": "description test here",
    "checkout": {
        "ln": "lnbc11120n1p0tk287pp579hs9fx4y6n604rszv6um73k4h27v6yqnk95nkdf68caf26l7w6qdpq2dhkkctjv3jkzmnydus82m3qd36kuetncqzpgxqrrs0sgejkzrj9h56k8akagqexnts0evpjvm9e4vh42wkld4r50rdmcp9nntxfz3tvksasxwqf9u3vshd992avre57z4ytjfp06rjrzwu3msqz0hvpn",
        "btc": "bc1q54l78fr4ct99yc0r3e5f9nc7rrtflw4a4fjf33",
        "url": "https://turinpay.com/f16f02a4d526a7a7d4701335cdfa36add5e668809d8b49d9a9d1f1d4ab5ff3b4"
    },
    "fees": 14926,
    "callbackUrl": "https://test.io/callback",
    "createdAt": "2020-05-12T22:53:50.000Z"
},
{
    "id": "f16f02a4d526a7a7d4701335cdfa36add5e668809d8b49d9a9d1f1d4ab5ff3b4",
    "status": "CONFIRMED",
    "customerId": 3,
    "description": "description test here",
    "checkout": {
        "ln": "lnbc11120n1p0tk287pp579hs9fx4y6n604rszv6um73k4h27v6yqnk95nkdf68caf26l7w6qdpq2dhkkctjv3jkzmnydus82m3qd36kuetncqzpgxqrrs0sgejkzrj9h56k8akagqexnts0evpjvm9e4vh42wkld4r50rdmcp9nntxfz3tvksasxwqf9u3vshd992avre57z4ytjfp06rjrzwu3msqz0hvpn",
        "btc": "bc1q54l78fr4ct99yc0r3e5f9nc7rrtflw4a4fjf33",
        "url": "https://turinpay.com/f16f02a4d526a7a7d4701335cdfa36add5e668809d8b49d9a9d1f1d4ab5ff3b4"
    },
    "fees": 14926,
    "callbackUrl": "https://test.io/callback",
    "createdAt": "2020-05-12T22:53:50.000Z"
}

Retrieve invoice

GET https://api.turinpay.com/invoices/:id

Retrieve a specific invoice by its id

Path Parameters

Name	Type	Description
id	string	Charge id

200 Returns an invoice instance

{
    "id": "f16f02a4d526a7a7d4701335cdfa36add5e668809d8b49d9a9d1f1d4ab5ff3b4",
    "status": "CONFIRMED",
    "customerId": 3,
    "description": "description test here",
    "checkout": {
        "ln": "lnbc11120n1p0tk287pp579hs9fx4y6n604rszv6um73k4h27v6yqnk95nkdf68caf26l7w6qdpq2dhkkctjv3jkzmnydus82m3qd36kuetncqzpgxqrrs0sgejkzrj9h56k8akagqexnts0evpjvm9e4vh42wkld4r50rdmcp9nntxfz3tvksasxwqf9u3vshd992avre57z4ytjfp06rjrzwu3msqz0hvpn",
        "btc": "bc1q54l78fr4ct99yc0r3e5f9nc7rrtflw4a4fjf33",
        "url": "https://turinpay.com/f16f02a4d526a7a7d4701335cdfa36add5e668809d8b49d9a9d1f1d4ab5ff3b4"
    },
    "fees": 14926,
    "callbackUrl": "https://test.io/callback",
    "createdAt": "2020-05-12T22:53:50.000Z"
}