Home
API Reference

Create an Invoice

post
https://api.tap.company/v2/invoices/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
boolean
Defaults to false

Merchant can save the invoice without creating the actual invoice. The default value will be false.

double
required
Defaults to 1672235072000

Invoice Due Date; measured in seconds since the Unix epoch.

double
required
Defaults to 1672235072000

Invoice Expiry Date; measured in seconds since the Unix epoch.

string
Defaults to test invoice

Invoice description.

string
Defaults to INVOICE

Invoice mode- how the invoice page is showed to customers (INVOICE - Open invoice page, PAY - Open payment page, INVOICEPAY - Open invoice page and payment page.

string
Defaults to test note

It will be added to the invoice footer.

notifications
object

Notification object. By default, the invoice will be dispatched automatically.

currencies
array of strings
Defaults to KWD

Currencies object. If you pass a null or empty value for the charge currency object, all available currencies will be displayed.

currencies
metadata
object

Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

charge
object

Charge Object.

customer
object
required

Customer object; either customer ID or customer information is required.

string
Defaults to test
order
object
required

Order object; either order ID or order information is required

payment_methods
array of strings

Charge payment method object. If you pass a null or empty value, then all available payment methods will be displayed and If you want to send link with specific payment method you can add "BENEFIT","VISA", "MASTERCARD", "APPLE_PAY"

payment_methods
post
object

Post url object.

redirect
object

Redirect url object.

reference
object

Merchant reference object.

boolean
Defaults to true

When set to false, the default behavior shifts, redirecting customers to the merchant's designated "redirect.url" instead of the invoice page upon an unsuccessful transaction.

payment_provider
object

Information about the payment provider associated with this invoice

Headers
string

optional

Responses

Updated 10 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago