This section will describe the Charges API overview, the request and response example.
Overview
To directly charge a credit or debit card, submit a request to create a charge using the Create a Charge endpoint. All charges are identified by unique charge_ids. You can also retrieve a charge, refund a charge or retrieve a list of charges.
You can also use this charges endpoint to Capture an authorized transaction.
The Payment Source Object
In the charge request, include source.id to indicate the payment source at the time of the transaction.
The possible values are below based on your choice.
Source ID
Description
src_sa.mada
mada (local payment switch in KSA). For this payment method, a transaction.url is always returned. Hence the user has to be redirected to this page after the Charge is INITIATED.
src_kw.knet
KNET (local payment switch in Kuwait). For this payment method, a transaction.url is always returned. Hence the user has to be redirected to this page after the Charge is INITIATED.
src_eg.fawry
FAWRY (local payment switch in Egypt). For this payment method, a transaction.url is always returned with the Fawry order details. Hence the user has to be redirected to this page after the Charge is IN PROGRESS so that the user can complete the payment at the Fawry Store.
src_bh.benefit
Benefit (local payment switch in Bahrain). For this payment method, a transaction.url is always returned. Hence the user has to be redirected to this page after the Charge is INITIATED.
src_benefitpay
Benefit (local payment switch in Bahrain). For this payment method, a transaction.url is always returned. Hence the user has to be redirected to this page after the Charge is INITIATEDwith two option to pay with QR code or pay by benefit pay app directly.
src_qa.qpay
NAPS/QPAY (local payment switch in Qatar) . For this payment method, a transaction.url is always returned in the response, hence the user has to be redirected to this page after the Charge is INITIATED.
src_tabby.installement
With Tabby, you can split your purchases into 4 interest-free payments, online or in-store. Here is the integration guide.
src_apple_pay
With Apple pay, you can pay with your apple device and by using safari browser easily.
src_google_pay
With Google pay, allow you to pay with your google account wallet.
src_sa.stcpay
STC Pay allows the customers in KSA to pay with their phone numbers registred in STC Pay
src_omannet
Omannet (local payment switch in Oman) . For this payment method, a transaction.url is always returned in the response, hence the user has to be redirected to this page after the Charge is INITIATED.
To capture the amount using the authorize.id generated from Create an Authorize.
src_card
To display ONLY the Card payment methods on a Tap hosted page. The Create a Charge will return the transaction.url for redirecting the user to the Tap hosted page.
src_all
To display all the payment methods enabled for the Merchant ID on a Tap hosted Page. The Create a Charge will return the transaction.url to redirect the user to the Tap hosted page.
📘
Redirect Payment Flow
For KNET, mada, Benefit and 3D Secure transactions, redirect.url should be passed in the Charges Request.
To split the amount, you can pass this optional Destinations Object in the charge request. And define the destination ID/s, desired amount, and currency. It will allow splitting the amount with sub-merchants(destinations), and the remaining amount will stay in the master account/wallet.
The default transaction expiry period is 30 minutes, but it can be adjusted. You can set it to a minimum of 5 minutes and a maximum of 60 minutes by including the optional transaction object and specifying the desired period as shown below.
If the charge request is valid, then Tap will return the charge response which includes the "status" field defining the status of the charge. The possible values are below
INITIATED - Tap will provide the payment URL (transaction.url) to process the payment.
The customer should be redirected to this URL in order to complete the payment.
CAPTURED - Amount was successfully charged.
ABANDONED, CANCELLED, FAILED, DECLINED, RESTRICTED, VOID, TIMEDOUT, UNKNOWN - Payment failed. Use the charge response code and message to identify the reason for failure.
customer.id
If you did not provide a customer ID in the charge request, Tap will create a customer ID for each successful transaction and share it within the charge response. You can store this customer ID for future charges, and authorizations, or for getting the list of charges or authorized transactions. You can also create a customer using Create a Customer
card.id
If you requested to save the card in the charge request, Tap will save the card and provide a card ID in the charge response if the transaction is successful. You can save this card ID and use it for future charges or authorizations. However, the card ID cannot be used directly in the charge or authorization request. You must first create a token ID using the saved card's ID and then pass the token ID along with the customer ID in the charge or authorization request.
\n\n## The Payment Source Object\n\nIn the charge request, include `source.id` to indicate the payment source at the time of the transaction.\\\nThe possible values are below based on your choice.\n\n| Source ID | Description |\n| :----------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `src_sa.mada` | **mada** (local payment switch in **KSA**). For this payment method, a `transaction.url` is always returned. Hence the user has to be redirected to this page after the Charge is `INITIATED`. |\n| `src_kw.knet` | **KNET** (local payment switch in **Kuwait**). For this payment method, a `transaction.url` is always returned. Hence the user has to be redirected to this page after the Charge is `INITIATED`. |\n| `src_eg.fawry` | **FAWRY** (local payment switch in **Egypt**). For this payment method, a `transaction.url` is always returned with the Fawry order details. Hence the user has to be redirected to this page after the Charge is `IN PROGRESS` so that the user can complete the payment at the Fawry Store. |\n| `src_bh.benefit` | **Benefit** (local payment switch in **Bahrain**). For this payment method, a `transaction.url` is always returned. Hence the user has to be redirected to this page after the Charge is `INITIATED`. |\n| src\\_benefitpay | **Benefit** (local payment switch in **Bahrain**). For this payment method, a `transaction.url` is always returned. Hence the user has to be redirected to this page after the Charge is `INITIATED`with two option to pay with QR code or pay by benefit pay app directly. |\n| src\\_qa.qpay | **NAPS/QPAY** (local payment switch in **Qatar**) . For this payment method, a `transaction.url` is always returned in the response, hence the user has to be redirected to this page after the Charge is `INITIATED`. |\n| `src_tabby.installement` | With **Tabby**, you can split your purchases into 4 interest-free payments, online or in-store. Here is the integration [guide](tabby). |\n| src\\_apple\\_pay | With **Apple pay**, you can pay with your apple device and by using safari browser easily. |\n| src\\_google\\_pay | With **Google pay**, allow you to pay with your google account wallet. |\n| src\\_sa.stcpay | **STC Pay** allows the customers in KSA to pay with their phone numbers registred in STC Pay |\n| src\\_omannet | **Omannet** (local payment switch in **Oman**) . For this payment method, a `transaction.url` is always returned in the response, hence the user has to be redirected to this page after the Charge is `INITIATED`. |\n| `token_id` | To capture the amount using the `token.id` generated from [Create a Token](ref:create-a-token) or [Card SDK](doc:card-js-library) or [Checkout SDK](doc:checkout-js-library). |\n| `authorize_id` | To capture the amount using the `authorize.id` generated from [Create an Authorize](ref:create-an-authorize). |\n| `src_card` | To display ONLY the Card payment methods on a Tap hosted page. The [Create a Charge](ref:create-a-charge) will return the `transaction.url` for redirecting the user to the Tap hosted page. |\n| `src_all` | To display all the payment methods enabled for the Merchant ID on a Tap hosted Page. The [Create a Charge](ref:create-a-charge) will return the `transaction.url` to redirect the user to the Tap hosted page. |\n\n> 📘 Redirect Payment Flow\n>\n> For **KNET, mada, Benefit** and 3D Secure transactions, `redirect.url` should be passed in the Charges Request.\n\n\n\n## Charge Payment Request\n\nSample\n\n```json\n{\n \"amount\": 10,\n \"currency\": \"AED\",\n \"threeDSecure\": true,\n \"save_card\": false/true, //based on your choice\n \"customer_initiated\":true,\n \"description\": \"Test Description\",\n \"statement_descriptor\": \"Sample\",\n \"metadata\": {\n \"udf1\": \"test 1\",\n \"udf2\": \"test 2\"\n },\n \"reference\": {\n \"transaction\": \"txn_0001\",\n \"order\": \"ord_0001\"\n },\n \"receipt\": {\n \"email\": true,\n \"sms\": false\n },\n\"customer\":{\n \"first_name\":\"Waleed\",\n \"last_name\":\"Asghar\",\n \"email\":\"w.asghar@tap.company\",\n \"phone\":{\n \"country_code\":\"971\",\n \"number\":\"586275033\"\n }\n },\n \"merchant\":{\n \"id\": \"\"\n },\n \"source\": {\n \"id\": \"src_all\"\n },\n \"post\": {\n \"url\": \"http://your_website.com/post_url\"\n },\n \"redirect\": {\n \"url\": \"http://your_website.com/redirect_url\"\n }\n}\n```\n\n## To Split The Payments (for Marketplace)\n\nTo split the amount, you can pass this optional Destinations Object in the charge request. And define the destination ID/s, desired amount, and currency. It will allow splitting the amount with sub-merchants(destinations), and the remaining amount will stay in the master account/wallet.\n\n```json\n\"destinations\": {\n \"destination\": [\n {\n \"id\": \"480593\",\n \"amount\": 2,\n \"currency\": \"AED\"\n },\n {\n \"id\": \"486374\",\n \"amount\": 3,\n \"currency\": \"AED\"\n }\n ]\n },\n```\n\n\n\n## To Set an Expiry period\n\nThe default transaction expiry period is 30 minutes, but it can be adjusted. You can set it to a minimum of 5 minutes and a maximum of 60 minutes by including the optional `transaction` object and specifying the desired period as shown below. \n\n```json\n \"transaction\": {\n \"expiry\": {\n \"period\": 60,\n \"type\": \"MINUTE\"\n }\n },\n```\n\n## Post Payment Response Details\n\nIf the charge request is valid, then Tap will return the charge response which includes the \"status\" field defining the status of the charge. The possible values are below\n\n`INITIATED, ABANDONED, CANCELLED, FAILED, DECLINED, RESTRICTED, CAPTURED, VOID, TIMEDOUT, UNKNOWN`\n\n`INITIATED` - Tap will provide the payment URL (`transaction.url`) to process the payment.\\\nThe customer should be redirected to this URL in order to complete the payment.\n\n`CAPTURED` - Amount was successfully charged.\n\n`ABANDONED, CANCELLED, FAILED, DECLINED, RESTRICTED, VOID, TIMEDOUT, UNKNOWN` - Payment failed. Use the charge response code and message to identify the reason for failure.\n\n`customer.id`\\\nIf you did not provide a customer ID in the charge request, Tap will create a customer ID for each successful transaction and share it within the charge response. You can store this customer ID for future charges, and authorizations, or for getting the list of charges or authorized transactions. You can also create a customer using [Create a Customer](ref:create-a-customer)\n\n`card.id`\\\nIf you requested to save the card in the charge request, Tap will save the card and provide a card ID in the charge response if the transaction is successful. You can save this card ID and use it for future charges or authorizations. However, the card ID cannot be used directly in the charge or authorization request. You must first create a token ID using the saved card's ID and then pass the token ID along with the customer ID in the charge or authorization request.\n\n### Expected Response\n\nSample\n\n```json\n{\n \"id\": \"chg_TS03A2220231551Ha3j1408926\",\n \"object\": \"charge\",\n \"live_mode\": false,\n \"customer_initiated\": true,\n \"api_version\": \"V2\",\n \"method\": \"GET\",\n \"status\": \"CAPTURED\",\n \"amount\": 10.00,\n \"currency\": \"AED\",\n \"threeDSecure\": true,\n \"card_threeDSecure\": false,\n \"save_card\": true,\n \"merchant_id\": \"\",\n \"product\": \"GOSELL\",\n \"statement_descriptor\": \"Sample\",\n \"description\": \"Test Description\",\n \"metadata\": {\n \"udf1\": \"test 1\",\n \"udf2\": \"test 2\"\n },\n \"order\": {\n \"id\": \"ord_lWdQ29231251p2pQ14NO7c311\"\n },\n \"transaction\": {\n \"authorization_id\": \"030982\",\n \"timezone\": \"UTC+03:00\",\n \"created\": \"1692028310505\",\n \"expiry\": {\n \"period\": 30,\n \"type\": \"MINUTE\"\n },\n \"asynchronous\": false,\n \"amount\": 10.00,\n \"currency\": \"AED\"\n },\n \"reference\": {\n \"track\": \"tck_TS01A2220231551t1K31408958\",\n \"payment\": \"2214231551089588145\",\n \"gateway\": \"123456789012345\",\n \"acquirer\": \"322612030982\",\n \"transaction\": \"txn_0001\",\n \"order\": \"ord_0001\"\n },\n \"response\": {\n \"code\": \"000\",\n \"message\": \"Captured\"\n },\n \"security\": {\n \"threeDSecure\": {\n \"id\": \"3ds_TS06A5020231551j5JH1408505\",\n \"status\": \"Y\"\n }\n },\n \"acquirer\": {\n \"response\": {\n \"code\": \"00\",\n \"message\": \"Approved\"\n }\n },\n \"gateway\": {\n \"response\": {\n \"code\": \"0\",\n \"message\": \"Transaction Approved\"\n }\n },\n \"card\": {\n \"id\": \"card_NOSc48231251fiLc14rl7u285\",\n \"object\": \"card\",\n \"first_six\": \"411111\",\n \"scheme\": \"VISA\",\n \"brand\": \"VISA\",\n \"last_four\": \"1111\"\n },\n \"receipt\": {\n \"id\": \"202314231551081692\",\n \"email\": true,\n \"sms\": false\n },\n \"customer\": {\n \"id\": \"cus_TS06A5220231551Rl7y1408020\",\n \"first_name\": \"Waleed\",\n \"last_name\": \"Asghar\",\n \"email\": \"w.asghar@tap.company\",\n \"phone\": {\n \"country_code\": \"971\",\n \"number\": \"586275033\"\n }\n },\n \"merchant\": {\n \"country\": \"AE\",\n \"currency\": \"AED\",\n \"id\": \"14583257\"\n },\n \"source\": {\n \"object\": \"token\",\n \"type\": \"CARD_NOT_PRESENT\",\n \"payment_type\": \"CREDIT\",\n \"payment_method\": \"VISA\",\n \"channel\": \"INTERNET\",\n \"id\": \"tok_mgtn48231251SX3414YZ7l282\"\n },\n \"redirect\": {\n \"status\": \"SUCCESS\",\n \"url\": \"http://your_website.com/redirect_url\"\n },\n \"post\": {\n \"status\": \"ERROR\",\n \"url\": \"http://your_website.com/post_url\"\n },\n \"activities\": [\n {\n \"id\": \"activity_TS07A5220231551Mj841408864\",\n \"object\": \"activity\",\n \"created\": 1692028310505,\n \"status\": \"INITIATED\",\n \"currency\": \"AED\",\n \"amount\": 10.00,\n \"remarks\": \"charge - created\"\n },\n {\n \"id\": \"activity_TS05A1020231552Oe1m1408270\",\n \"object\": \"activity\",\n \"created\": 1692028330270,\n \"status\": \"CAPTURED\",\n \"currency\": \"AED\",\n \"amount\": 10.00,\n \"remarks\": \"charge - captured\"\n }\n ],\n \"auto_reversed\": false,\n \"payment_agreement\": {\n \"id\": \"payment_agreement_h5Rp522312517fHg14Vg7a661\",\n \"type\": \"UNSCHEDULED\",\n \"total_payments_count\": 1,\n \"contract\": {\n \"id\": \"card_NOSc48231251fiLc14rl7u285\",\n \"customer_id\": \"cus_TS06A5220231551Rl7y1408020\",\n \"type\": \"SAVED_CARD\"\n },\n \"metadata\": {\n \"txn_type\": \"CHARGE\",\n \"txn_id\": \"chg_TS03A2220231551Ha3j1408926\",\n \"terminal_id\": \"ter_p3F64020211320j6XQ1002702\"\n }\n }\n}\n```","excerpt":"This section will describe the Charges API overview, the request and response example.","link":{"url":null,"new_tab":false},"next":{"description":null,"pages":[]}},"metadata":{"description":null,"image":{"uri":null,"url":null},"keywords":null,"title":null},"parent":{"uri":null},"privacy":{"view":"public"},"slug":"charges","state":"current","title":"Charges","type":"basic","api_config":null,"api":{"method":"get","path":"","schema":null,"stats":{"additional_properties":false,"callbacks":false,"circular_references":false,"common_parameters":false,"discriminators":false,"links":false,"polymorphism":false,"references":false,"server_variables":false,"style":false,"webhooks":false,"xml_requests":false,"xml_responses":false,"xml_schemas":false},"source":null,"uri":null},"connections":{"recipes":[]},"href":{"dash":"https://dash.readme.com/project/tappayments/v1.0/refs/charges","hub":"https://developers.tap.company/reference/charges"},"links":{"project":"/projects/me"},"project":{"name":"Tap API Docs 1.0","subdomain":"tappayments","uri":"/projects/me"},"renderable":{"status":true},"updated_at":"2025-06-16T13:26:30.461Z","uri":"/branches/1.0/reference/charges"},"meta":{"baseUrl":"/","description":"This section will describe the Charges API overview, the request and response example.","hidden":false,"image":[],"metaTitle":"Charges","robots":"index","slug":"charges","title":"Charges","type":"reference"},"oauth":false,"rdmd":{"baseUrl":"/","body":"## Overview\n\nTo directly charge a credit or debit card, submit a request to create a charge using the [Create a Charge](ref:create-a-charge) endpoint. All charges are identified by unique charge\\_ids. You can also retrieve a charge, refund a charge or retrieve a list of charges.\n\nYou can also use this charges endpoint to Capture an authorized transaction.\n\n\n\n## The Payment Source Object\n\nIn the charge request, include `source.id` to indicate the payment source at the time of the transaction.\\\nThe possible values are below based on your choice.\n\n| Source ID | Description |\n| :----------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `src_sa.mada` | **mada** (local payment switch in **KSA**). For this payment method, a `transaction.url` is always returned. Hence the user has to be redirected to this page after the Charge is `INITIATED`. |\n| `src_kw.knet` | **KNET** (local payment switch in **Kuwait**). For this payment method, a `transaction.url` is always returned. Hence the user has to be redirected to this page after the Charge is `INITIATED`. |\n| `src_eg.fawry` | **FAWRY** (local payment switch in **Egypt**). For this payment method, a `transaction.url` is always returned with the Fawry order details. Hence the user has to be redirected to this page after the Charge is `IN PROGRESS` so that the user can complete the payment at the Fawry Store. |\n| `src_bh.benefit` | **Benefit** (local payment switch in **Bahrain**). For this payment method, a `transaction.url` is always returned. Hence the user has to be redirected to this page after the Charge is `INITIATED`. |\n| src\\_benefitpay | **Benefit** (local payment switch in **Bahrain**). For this payment method, a `transaction.url` is always returned. Hence the user has to be redirected to this page after the Charge is `INITIATED`with two option to pay with QR code or pay by benefit pay app directly. |\n| src\\_qa.qpay | **NAPS/QPAY** (local payment switch in **Qatar**) . For this payment method, a `transaction.url` is always returned in the response, hence the user has to be redirected to this page after the Charge is `INITIATED`. |\n| `src_tabby.installement` | With **Tabby**, you can split your purchases into 4 interest-free payments, online or in-store. Here is the integration [guide](tabby). |\n| src\\_apple\\_pay | With **Apple pay**, you can pay with your apple device and by using safari browser easily. |\n| src\\_google\\_pay | With **Google pay**, allow you to pay with your google account wallet. |\n| src\\_sa.stcpay | **STC Pay** allows the customers in KSA to pay with their phone numbers registred in STC Pay |\n| src\\_omannet | **Omannet** (local payment switch in **Oman**) . For this payment method, a `transaction.url` is always returned in the response, hence the user has to be redirected to this page after the Charge is `INITIATED`. |\n| `token_id` | To capture the amount using the `token.id` generated from [Create a Token](ref:create-a-token) or [Card SDK](doc:card-js-library) or [Checkout SDK](doc:checkout-js-library). |\n| `authorize_id` | To capture the amount using the `authorize.id` generated from [Create an Authorize](ref:create-an-authorize). |\n| `src_card` | To display ONLY the Card payment methods on a Tap hosted page. The [Create a Charge](ref:create-a-charge) will return the `transaction.url` for redirecting the user to the Tap hosted page. |\n| `src_all` | To display all the payment methods enabled for the Merchant ID on a Tap hosted Page. The [Create a Charge](ref:create-a-charge) will return the `transaction.url` to redirect the user to the Tap hosted page. |\n\n> 📘 Redirect Payment Flow\n>\n> For **KNET, mada, Benefit** and 3D Secure transactions, `redirect.url` should be passed in the Charges Request.\n\n\n\n## Charge Payment Request\n\nSample\n\n```json\n{\n \"amount\": 10,\n \"currency\": \"AED\",\n \"threeDSecure\": true,\n \"save_card\": false/true, //based on your choice\n \"customer_initiated\":true,\n \"description\": \"Test Description\",\n \"statement_descriptor\": \"Sample\",\n \"metadata\": {\n \"udf1\": \"test 1\",\n \"udf2\": \"test 2\"\n },\n \"reference\": {\n \"transaction\": \"txn_0001\",\n \"order\": \"ord_0001\"\n },\n \"receipt\": {\n \"email\": true,\n \"sms\": false\n },\n\"customer\":{\n \"first_name\":\"Waleed\",\n \"last_name\":\"Asghar\",\n \"email\":\"w.asghar@tap.company\",\n \"phone\":{\n \"country_code\":\"971\",\n \"number\":\"586275033\"\n }\n },\n \"merchant\":{\n \"id\": \"\"\n },\n \"source\": {\n \"id\": \"src_all\"\n },\n \"post\": {\n \"url\": \"http://your_website.com/post_url\"\n },\n \"redirect\": {\n \"url\": \"http://your_website.com/redirect_url\"\n }\n}\n```\n\n## To Split The Payments (for Marketplace)\n\nTo split the amount, you can pass this optional Destinations Object in the charge request. And define the destination ID/s, desired amount, and currency. It will allow splitting the amount with sub-merchants(destinations), and the remaining amount will stay in the master account/wallet.\n\n```json\n\"destinations\": {\n \"destination\": [\n {\n \"id\": \"480593\",\n \"amount\": 2,\n \"currency\": \"AED\"\n },\n {\n \"id\": \"486374\",\n \"amount\": 3,\n \"currency\": \"AED\"\n }\n ]\n },\n```\n\n\n\n## To Set an Expiry period\n\nThe default transaction expiry period is 30 minutes, but it can be adjusted. You can set it to a minimum of 5 minutes and a maximum of 60 minutes by including the optional `transaction` object and specifying the desired period as shown below. \n\n```json\n \"transaction\": {\n \"expiry\": {\n \"period\": 60,\n \"type\": \"MINUTE\"\n }\n },\n```\n\n## Post Payment Response Details\n\nIf the charge request is valid, then Tap will return the charge response which includes the \"status\" field defining the status of the charge. The possible values are below\n\n`INITIATED, ABANDONED, CANCELLED, FAILED, DECLINED, RESTRICTED, CAPTURED, VOID, TIMEDOUT, UNKNOWN`\n\n`INITIATED` - Tap will provide the payment URL (`transaction.url`) to process the payment.\\\nThe customer should be redirected to this URL in order to complete the payment.\n\n`CAPTURED` - Amount was successfully charged.\n\n`ABANDONED, CANCELLED, FAILED, DECLINED, RESTRICTED, VOID, TIMEDOUT, UNKNOWN` - Payment failed. Use the charge response code and message to identify the reason for failure.\n\n`customer.id`\\\nIf you did not provide a customer ID in the charge request, Tap will create a customer ID for each successful transaction and share it within the charge response. You can store this customer ID for future charges, and authorizations, or for getting the list of charges or authorized transactions. You can also create a customer using [Create a Customer](ref:create-a-customer)\n\n`card.id`\\\nIf you requested to save the card in the charge request, Tap will save the card and provide a card ID in the charge response if the transaction is successful. You can save this card ID and use it for future charges or authorizations. However, the card ID cannot be used directly in the charge or authorization request. You must first create a token ID using the saved card's ID and then pass the token ID along with the customer ID in the charge or authorization request.\n\n### Expected Response\n\nSample\n\n```json\n{\n \"id\": \"chg_TS03A2220231551Ha3j1408926\",\n \"object\": \"charge\",\n \"live_mode\": false,\n \"customer_initiated\": true,\n \"api_version\": \"V2\",\n \"method\": \"GET\",\n \"status\": \"CAPTURED\",\n \"amount\": 10.00,\n \"currency\": \"AED\",\n \"threeDSecure\": true,\n \"card_threeDSecure\": false,\n \"save_card\": true,\n \"merchant_id\": \"\",\n \"product\": \"GOSELL\",\n \"statement_descriptor\": \"Sample\",\n \"description\": \"Test Description\",\n \"metadata\": {\n \"udf1\": \"test 1\",\n \"udf2\": \"test 2\"\n },\n \"order\": {\n \"id\": \"ord_lWdQ29231251p2pQ14NO7c311\"\n },\n \"transaction\": {\n \"authorization_id\": \"030982\",\n \"timezone\": \"UTC+03:00\",\n \"created\": \"1692028310505\",\n \"expiry\": {\n \"period\": 30,\n \"type\": \"MINUTE\"\n },\n \"asynchronous\": false,\n \"amount\": 10.00,\n \"currency\": \"AED\"\n },\n \"reference\": {\n \"track\": \"tck_TS01A2220231551t1K31408958\",\n \"payment\": \"2214231551089588145\",\n \"gateway\": \"123456789012345\",\n \"acquirer\": \"322612030982\",\n \"transaction\": \"txn_0001\",\n \"order\": \"ord_0001\"\n },\n \"response\": {\n \"code\": \"000\",\n \"message\": \"Captured\"\n },\n \"security\": {\n \"threeDSecure\": {\n \"id\": \"3ds_TS06A5020231551j5JH1408505\",\n \"status\": \"Y\"\n }\n },\n \"acquirer\": {\n \"response\": {\n \"code\": \"00\",\n \"message\": \"Approved\"\n }\n },\n \"gateway\": {\n \"response\": {\n \"code\": \"0\",\n \"message\": \"Transaction Approved\"\n }\n },\n \"card\": {\n \"id\": \"card_NOSc48231251fiLc14rl7u285\",\n \"object\": \"card\",\n \"first_six\": \"411111\",\n \"scheme\": \"VISA\",\n \"brand\": \"VISA\",\n \"last_four\": \"1111\"\n },\n \"receipt\": {\n \"id\": \"202314231551081692\",\n \"email\": true,\n \"sms\": false\n },\n \"customer\": {\n \"id\": \"cus_TS06A5220231551Rl7y1408020\",\n \"first_name\": \"Waleed\",\n \"last_name\": \"Asghar\",\n \"email\": \"w.asghar@tap.company\",\n \"phone\": {\n \"country_code\": \"971\",\n \"number\": \"586275033\"\n }\n },\n \"merchant\": {\n \"country\": \"AE\",\n \"currency\": \"AED\",\n \"id\": \"14583257\"\n },\n \"source\": {\n \"object\": \"token\",\n \"type\": \"CARD_NOT_PRESENT\",\n \"payment_type\": \"CREDIT\",\n \"payment_method\": \"VISA\",\n \"channel\": \"INTERNET\",\n \"id\": \"tok_mgtn48231251SX3414YZ7l282\"\n },\n \"redirect\": {\n \"status\": \"SUCCESS\",\n \"url\": \"http://your_website.com/redirect_url\"\n },\n \"post\": {\n \"status\": \"ERROR\",\n \"url\": \"http://your_website.com/post_url\"\n },\n \"activities\": [\n {\n \"id\": \"activity_TS07A5220231551Mj841408864\",\n \"object\": \"activity\",\n \"created\": 1692028310505,\n \"status\": \"INITIATED\",\n \"currency\": \"AED\",\n \"amount\": 10.00,\n \"remarks\": \"charge - created\"\n },\n {\n \"id\": \"activity_TS05A1020231552Oe1m1408270\",\n \"object\": \"activity\",\n \"created\": 1692028330270,\n \"status\": \"CAPTURED\",\n \"currency\": \"AED\",\n \"amount\": 10.00,\n \"remarks\": \"charge - captured\"\n }\n ],\n \"auto_reversed\": false,\n \"payment_agreement\": {\n \"id\": \"payment_agreement_h5Rp522312517fHg14Vg7a661\",\n \"type\": \"UNSCHEDULED\",\n \"total_payments_count\": 1,\n \"contract\": {\n \"id\": \"card_NOSc48231251fiLc14rl7u285\",\n \"customer_id\": \"cus_TS06A5220231551Rl7y1408020\",\n \"type\": \"SAVED_CARD\"\n },\n \"metadata\": {\n \"txn_type\": \"CHARGE\",\n \"txn_id\": \"chg_TS03A2220231551Ha3j1408926\",\n \"terminal_id\": \"ter_p3F64020211320j6XQ1002702\"\n }\n }\n}\n```","dehydrated":{"toc":"","body":"
Overview
\n
To directly charge a credit or debit card, submit a request to create a charge using the Create a Charge endpoint. All charges are identified by unique charge_ids. You can also retrieve a charge, refund a charge or retrieve a list of charges.
\n
You can also use this charges endpoint to Capture an authorized transaction.
\n\n
The Payment Source Object
\n
In the charge request, include source.id to indicate the payment source at the time of the transaction. \nThe possible values are below based on your choice.
\n
Source ID
Description
src_sa.mada
mada (local payment switch in KSA). For this payment method, a transaction.url is always returned. Hence the user has to be redirected to this page after the Charge is INITIATED.
src_kw.knet
KNET (local payment switch in Kuwait). For this payment method, a transaction.url is always returned. Hence the user has to be redirected to this page after the Charge is INITIATED.
src_eg.fawry
FAWRY (local payment switch in Egypt). For this payment method, a transaction.url is always returned with the Fawry order details. Hence the user has to be redirected to this page after the Charge is IN PROGRESS so that the user can complete the payment at the Fawry Store.
src_bh.benefit
Benefit (local payment switch in Bahrain). For this payment method, a transaction.url is always returned. Hence the user has to be redirected to this page after the Charge is INITIATED.
src_benefitpay
Benefit (local payment switch in Bahrain). For this payment method, a transaction.url is always returned. Hence the user has to be redirected to this page after the Charge is INITIATEDwith two option to pay with QR code or pay by benefit pay app directly.
src_qa.qpay
NAPS/QPAY (local payment switch in Qatar) . For this payment method, a transaction.url is always returned in the response, hence the user has to be redirected to this page after the Charge is INITIATED.
src_tabby.installement
With Tabby, you can split your purchases into 4 interest-free payments, online or in-store. Here is the integration guide.
src_apple_pay
With Apple pay, you can pay with your apple device and by using safari browser easily.
src_google_pay
With Google pay, allow you to pay with your google account wallet.
src_sa.stcpay
STC Pay allows the customers in KSA to pay with their phone numbers registred in STC Pay
src_omannet
Omannet (local payment switch in Oman) . For this payment method, a transaction.url is always returned in the response, hence the user has to be redirected to this page after the Charge is INITIATED.
To capture the amount using the authorize.id generated from Create an Authorize.
src_card
To display ONLY the Card payment methods on a Tap hosted page. The Create a Charge will return the transaction.url for redirecting the user to the Tap hosted page.
src_all
To display all the payment methods enabled for the Merchant ID on a Tap hosted Page. The Create a Charge will return the transaction.url to redirect the user to the Tap hosted page.
\n
📘
Redirect Payment Flow
For KNET, mada, Benefit and 3D Secure transactions, redirect.url should be passed in the Charges Request.
To split the amount, you can pass this optional Destinations Object in the charge request. And define the destination ID/s, desired amount, and currency. It will allow splitting the amount with sub-merchants(destinations), and the remaining amount will stay in the master account/wallet.
The default transaction expiry period is 30 minutes, but it can be adjusted. You can set it to a minimum of 5 minutes and a maximum of 60 minutes by including the optional transaction object and specifying the desired period as shown below.
If the charge request is valid, then Tap will return the charge response which includes the "status" field defining the status of the charge. The possible values are below
INITIATED - Tap will provide the payment URL (transaction.url) to process the payment. \nThe customer should be redirected to this URL in order to complete the payment.
\n
CAPTURED - Amount was successfully charged.
\n
ABANDONED, CANCELLED, FAILED, DECLINED, RESTRICTED, VOID, TIMEDOUT, UNKNOWN - Payment failed. Use the charge response code and message to identify the reason for failure.
\n
customer.id \nIf you did not provide a customer ID in the charge request, Tap will create a customer ID for each successful transaction and share it within the charge response. You can store this customer ID for future charges, and authorizations, or for getting the list of charges or authorized transactions. You can also create a customer using Create a Customer
\n
card.id \nIf you requested to save the card in the charge request, Tap will save the card and provide a card ID in the charge response if the transaction is successful. You can save this card ID and use it for future charges or authorizations. However, the card ID cannot be used directly in the charge or authorization request. You must first create a token ID using the saved card's ID and then pass the token ID along with the customer ID in the charge or authorization request.
","css":"/*! tailwindcss v4.1.6 | MIT License | https://tailwindcss.com */\n@layer theme, base, components, utilities;\n@layer utilities;\n"},"mdx":true,"opts":{"alwaysThrow":false,"compatibilityMode":false,"copyButtons":true,"correctnewlines":false,"markdownOptions":{"fences":true,"commonmark":true,"gfm":true,"ruleSpaces":false,"listItemIndent":"1","spacedTable":true,"paddedTable":true},"lazyImages":true,"normalize":true,"safeMode":false,"settings":{"position":false},"theme":"light","customBlocks":{},"resourceID":"/branches/1.0/reference/charges","resourceType":"page","components":{},"baseUrl":"/","terms":[{"_id":"609181673ecbe5000fceea45","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"},{"_id":"644a67ce58a5e3035857ee5f","term":"MID","definition":"Merchant ID"},{"_id":"65cb1bc0a5ae180057f5b1ac","term":"charge_id","definition":"Charge_id is the transaction id"},{"_id":"65cb1c46a5f15f002857ddb3","term":"destinations","definition":"Destinations in this context refer to specific entities or accounts where portions of a transaction amount are directed to a single/multiple accounts."}],"variables":{"user":{},"defaults":[{"source":"security","_id":"62e8bff18f830d02d6155225","name":"Authorization","type":"apiKey","default":"sk_test_oqAcdQztv84agVkCBZEup0Hh","apiSetting":"614aeaa22843b7000fe98330"},{"source":"security","_id":"646b514404003f0045ac6eda","name":"test","type":"apiKey","default":"test","apiSetting":"644a369fbc093f0068977db4"}]}},"terms":[{"_id":"609181673ecbe5000fceea45","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"},{"_id":"644a67ce58a5e3035857ee5f","term":"MID","definition":"Merchant ID"},{"_id":"65cb1bc0a5ae180057f5b1ac","term":"charge_id","definition":"Charge_id is the transaction id"},{"_id":"65cb1c46a5f15f002857ddb3","term":"destinations","definition":"Destinations in this context refer to specific entities or accounts where portions of a transaction amount are directed to a single/multiple accounts."}],"variables":{"user":{},"defaults":[{"source":"security","_id":"62e8bff18f830d02d6155225","name":"Authorization","type":"apiKey","default":"sk_test_oqAcdQztv84agVkCBZEup0Hh","apiSetting":"614aeaa22843b7000fe98330"},{"source":"security","_id":"646b514404003f0045ac6eda","name":"test","type":"apiKey","default":"test","apiSetting":"644a369fbc093f0068977db4"}]}},"sidebar":[{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"api-endpoint","title":"API Authentication","type":"basic","updatedAt":"2025-06-21T11:50:59.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"api-actions","title":"API Actions","type":"basic","updatedAt":"2025-06-21T11:50:59.000Z","pages":[],"uri":"/branches/1.0/reference/api-actions","category":"/branches/1.0/categories/reference/Introduction","parent":"/branches/1.0/reference/api-endpoint"}],"uri":"/branches/1.0/reference/api-endpoint","category":"/branches/1.0/categories/reference/Introduction","parent":null}],"title":"Introduction","uri":"/branches/1.0/categories/reference/Introduction"},{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"authorize","title":"Authorize","type":"basic","updatedAt":"2025-06-21T11:50:59.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"create-an-authorize","title":"Create an Authorize","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/create-an-authorize","category":"/branches/1.0/categories/reference/Acceptance","parent":"/branches/1.0/reference/authorize"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"retrieve-an-authorize","title":"Retrieve an Authorize","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/retrieve-an-authorize","category":"/branches/1.0/categories/reference/Acceptance","parent":"/branches/1.0/reference/authorize"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"update-an-authorize","title":"Update an Authorize","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"put","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/update-an-authorize","category":"/branches/1.0/categories/reference/Acceptance","parent":"/branches/1.0/reference/authorize"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"void-an-authorize","title":"Void an Authorize","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/void-an-authorize","category":"/branches/1.0/categories/reference/Acceptance","parent":"/branches/1.0/reference/authorize"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"list-all-authorize","title":"List All Authorize","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/list-all-authorize","category":"/branches/1.0/categories/reference/Acceptance","parent":"/branches/1.0/reference/authorize"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"download-authorize","title":"Download Authorize","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/download-authorize","category":"/branches/1.0/categories/reference/Acceptance","parent":"/branches/1.0/reference/authorize"}],"uri":"/branches/1.0/reference/authorize","category":"/branches/1.0/categories/reference/Acceptance","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"charges","title":"Charges","type":"basic","updatedAt":"2025-06-21T11:50:59.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"create-a-charge","title":"Create a Charge","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/create-a-charge","category":"/branches/1.0/categories/reference/Acceptance","parent":"/branches/1.0/reference/charges"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"retrieve-a-charges","title":"Retrieve a Charge","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/retrieve-a-charges","category":"/branches/1.0/categories/reference/Acceptance","parent":"/branches/1.0/reference/charges"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"update-a-charge","title":"Update a Charge","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"put","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/update-a-charge","category":"/branches/1.0/categories/reference/Acceptance","parent":"/branches/1.0/reference/charges"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"list-all-charges","title":"List all Charges","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/list-all-charges","category":"/branches/1.0/categories/reference/Acceptance","parent":"/branches/1.0/reference/charges"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"download-charges","title":"Download Charges","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/download-charges","category":"/branches/1.0/categories/reference/Acceptance","parent":"/branches/1.0/reference/charges"}],"uri":"/branches/1.0/reference/charges","category":"/branches/1.0/categories/reference/Acceptance","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"refunds","title":"Refund","type":"basic","updatedAt":"2025-06-21T11:50:59.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"create-a-refund","title":"Create a Refund","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/create-a-refund","category":"/branches/1.0/categories/reference/Acceptance","parent":"/branches/1.0/reference/refunds"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"retrieve-a-refund","title":"Retrieve a Refund","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/retrieve-a-refund","category":"/branches/1.0/categories/reference/Acceptance","parent":"/branches/1.0/reference/refunds"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"update-a-refund","title":"Update a Refund","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"put","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/update-a-refund","category":"/branches/1.0/categories/reference/Acceptance","parent":"/branches/1.0/reference/refunds"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"list-all-refunds","title":"List All Refunds","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/list-all-refunds","category":"/branches/1.0/categories/reference/Acceptance","parent":"/branches/1.0/reference/refunds"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"download-refunds","title":"Download Refunds","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/download-refunds","category":"/branches/1.0/categories/reference/Acceptance","parent":"/branches/1.0/reference/refunds"}],"uri":"/branches/1.0/reference/refunds","category":"/branches/1.0/categories/reference/Acceptance","parent":null}],"title":"Acceptance","uri":"/branches/1.0/categories/reference/Acceptance"},{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"tokens","title":"Tokens","type":"basic","updatedAt":"2025-06-21T11:50:59.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"create-a-token","title":"Create a Token (Card)","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/create-a-token","category":"/branches/1.0/categories/reference/TOKENS","parent":"/branches/1.0/reference/tokens"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"create-a-token-encrypted-card","title":"Create a Token (Encrypted Card)","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/create-a-token-encrypted-card","category":"/branches/1.0/categories/reference/TOKENS","parent":"/branches/1.0/reference/tokens"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"create-a-token-from-saved-card","title":"Create a Token (Saved Card)","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/create-a-token-from-saved-card","category":"/branches/1.0/categories/reference/TOKENS","parent":"/branches/1.0/reference/tokens"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"create-applepay-tap-token","title":"Create a Token (Apple Pay token)","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/create-applepay-tap-token","category":"/branches/1.0/categories/reference/TOKENS","parent":"/branches/1.0/reference/tokens"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"create-samsungpay-token","title":"Create a Token (Samsungpay token)","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/create-samsungpay-token","category":"/branches/1.0/categories/reference/TOKENS","parent":"/branches/1.0/reference/tokens"},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"retrieve-a-token","title":"Retrieve a Token","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/retrieve-a-token","category":"/branches/1.0/categories/reference/TOKENS","parent":"/branches/1.0/reference/tokens"}],"uri":"/branches/1.0/reference/tokens","category":"/branches/1.0/categories/reference/TOKENS","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"cards-2","title":"Cards","type":"basic","updatedAt":"2025-06-21T11:50:59.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"retrieve-a-card","title":"Retrieve a Card","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/retrieve-a-card","category":"/branches/1.0/categories/reference/TOKENS","parent":"/branches/1.0/reference/cards-2"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"verify-a-card","title":"Verify a Card","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/verify-a-card","category":"/branches/1.0/categories/reference/TOKENS","parent":"/branches/1.0/reference/cards-2"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"delete-a-card","title":"Delete a Card","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"delete","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/delete-a-card","category":"/branches/1.0/categories/reference/TOKENS","parent":"/branches/1.0/reference/cards-2"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"list-all-cards","title":"List All Cards","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/list-all-cards","category":"/branches/1.0/categories/reference/TOKENS","parent":"/branches/1.0/reference/cards-2"}],"uri":"/branches/1.0/reference/cards-2","category":"/branches/1.0/categories/reference/TOKENS","parent":null}],"title":"TOKENS","uri":"/branches/1.0/categories/reference/TOKENS"},{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"invoices","title":"Invoices","type":"basic","updatedAt":"2025-06-21T11:50:59.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"create-an-invoice","title":"Create an Invoice","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/create-an-invoice","category":"/branches/1.0/categories/reference/Billing","parent":"/branches/1.0/reference/invoices"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"retrieve-an-invoice","title":"Retrieve an Invoice","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/retrieve-an-invoice","category":"/branches/1.0/categories/reference/Billing","parent":"/branches/1.0/reference/invoices"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"update-an-invoice","title":"Update an Invoice","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"put","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/update-an-invoice","category":"/branches/1.0/categories/reference/Billing","parent":"/branches/1.0/reference/invoices"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"cancel-an-invoice","title":"Cancel an Invoice","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"delete","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/cancel-an-invoice","category":"/branches/1.0/categories/reference/Billing","parent":"/branches/1.0/reference/invoices"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"remind-an-invoice","title":"Remind an Invoice","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/remind-an-invoice","category":"/branches/1.0/categories/reference/Billing","parent":"/branches/1.0/reference/invoices"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"finalize-an-invoice","title":"Finalize an Invoice","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/finalize-an-invoice","category":"/branches/1.0/categories/reference/Billing","parent":"/branches/1.0/reference/invoices"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"list-all-invoices","title":"List all Invoices","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/list-all-invoices","category":"/branches/1.0/categories/reference/Billing","parent":"/branches/1.0/reference/invoices"}],"uri":"/branches/1.0/reference/invoices","category":"/branches/1.0/categories/reference/Billing","parent":null}],"title":"Billing","uri":"/branches/1.0/categories/reference/Billing"},{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"payout","title":"Payout","type":"basic","updatedAt":"2025-06-21T11:50:59.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"retrieve-a-payout","title":"Retrieve a Payout","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/retrieve-a-payout","category":"/branches/1.0/categories/reference/Payouts","parent":"/branches/1.0/reference/payout"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"list-payouts","title":"List All Payouts","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/list-payouts","category":"/branches/1.0/categories/reference/Payouts","parent":"/branches/1.0/reference/payout"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"download-payouts","title":"Download Payouts","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/download-payouts","category":"/branches/1.0/categories/reference/Payouts","parent":"/branches/1.0/reference/payout"}],"uri":"/branches/1.0/reference/payout","category":"/branches/1.0/categories/reference/Payouts","parent":null}],"title":"Payouts","uri":"/branches/1.0/categories/reference/Payouts"},{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"lead","title":"Lead","type":"basic","updatedAt":"2025-06-21T11:50:59.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"create-a-lead-v3","title":"Create a Lead","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/create-a-lead-v3","category":"/branches/1.0/categories/reference/Accounts","parent":"/branches/1.0/reference/lead"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"retrieve-a-lead","title":"Retrieve a Lead","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/retrieve-a-lead","category":"/branches/1.0/categories/reference/Accounts","parent":"/branches/1.0/reference/lead"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"create-a-connect-url","title":"Create a Connect URL","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/create-a-connect-url","category":"/branches/1.0/categories/reference/Accounts","parent":"/branches/1.0/reference/lead"}],"uri":"/branches/1.0/reference/lead","category":"/branches/1.0/categories/reference/Accounts","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"business","title":"Business","type":"basic","updatedAt":"2025-06-21T11:50:59.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"create-a-business","title":"Create a Business","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/create-a-business","category":"/branches/1.0/categories/reference/Accounts","parent":"/branches/1.0/reference/business"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"retrieve-a-business","title":"Retrieve a Business","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/retrieve-a-business","category":"/branches/1.0/categories/reference/Accounts","parent":"/branches/1.0/reference/business"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"list-all-businesses","title":"List All Businesses","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/list-all-businesses","category":"/branches/1.0/categories/reference/Accounts","parent":"/branches/1.0/reference/business"}],"uri":"/branches/1.0/reference/business","category":"/branches/1.0/categories/reference/Accounts","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"destinations","title":"Destinations","type":"basic","updatedAt":"2025-06-21T11:50:59.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"retrieve-a-destination","title":"Retrieve a Destination","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/retrieve-a-destination","category":"/branches/1.0/categories/reference/Accounts","parent":"/branches/1.0/reference/destinations"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"list-all-destinations","title":"List All Destinations","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/list-all-destinations","category":"/branches/1.0/categories/reference/Accounts","parent":"/branches/1.0/reference/destinations"}],"uri":"/branches/1.0/reference/destinations","category":"/branches/1.0/categories/reference/Accounts","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"getting-started-with-your-api-10","title":"Merchant","type":"basic","updatedAt":"2025-06-21T11:50:59.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"create-a-merchant","title":"Create a Merchant","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/create-a-merchant","category":"/branches/1.0/categories/reference/Accounts","parent":"/branches/1.0/reference/getting-started-with-your-api-10"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"retrieve-a-merchant","title":"Retrieve a Merchant","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/retrieve-a-merchant","category":"/branches/1.0/categories/reference/Accounts","parent":"/branches/1.0/reference/getting-started-with-your-api-10"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"archive-a-merchant","title":"Archive a Merchant","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"delete","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/archive-a-merchant","category":"/branches/1.0/categories/reference/Accounts","parent":"/branches/1.0/reference/getting-started-with-your-api-10"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"list-all-merchants","title":"List All Merchants","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/list-all-merchants","category":"/branches/1.0/categories/reference/Accounts","parent":"/branches/1.0/reference/getting-started-with-your-api-10"}],"uri":"/branches/1.0/reference/getting-started-with-your-api-10","category":"/branches/1.0/categories/reference/Accounts","parent":null}],"title":"Accounts","uri":"/branches/1.0/categories/reference/Accounts"},{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"customers","title":"Customers","type":"basic","updatedAt":"2025-06-21T11:50:59.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"create-a-customer","title":"Create a Customer","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/create-a-customer","category":"/branches/1.0/categories/reference/Individual","parent":"/branches/1.0/reference/customers"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"retrieve-a-customer","title":"Retrieve a Customer ","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/retrieve-a-customer","category":"/branches/1.0/categories/reference/Individual","parent":"/branches/1.0/reference/customers"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"update-a-customer","title":"Update a Customer ","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"put","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/update-a-customer","category":"/branches/1.0/categories/reference/Individual","parent":"/branches/1.0/reference/customers"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"customer-list","title":"List All Customers","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/customer-list","category":"/branches/1.0/categories/reference/Individual","parent":"/branches/1.0/reference/customers"}],"uri":"/branches/1.0/reference/customers","category":"/branches/1.0/categories/reference/Individual","parent":null}],"title":"Individual","uri":"/branches/1.0/categories/reference/Individual"},{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"files","title":"Files","type":"basic","updatedAt":"2025-06-21T11:50:59.000Z","pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"create-a-file","title":"Create a File","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/create-a-file","category":"/branches/1.0/categories/reference/Files","parent":"/branches/1.0/reference/files"},{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"retrieve-a-file","title":"Retrieve a File","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"get","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/retrieve-a-file","category":"/branches/1.0/categories/reference/Files","parent":"/branches/1.0/reference/files"}],"uri":"/branches/1.0/reference/files","category":"/branches/1.0/categories/reference/Files","parent":null}],"title":"Files","uri":"/branches/1.0/categories/reference/Files"},{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"webhook-api","title":"Payout Webhook and Download API","type":"basic","updatedAt":"2025-06-21T11:50:59.000Z","pages":[],"uri":"/branches/1.0/reference/webhook-api","category":"/branches/1.0/categories/reference/payout","parent":null}],"title":"payout","uri":"/branches/1.0/categories/reference/payout"},{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"testing-keys","title":"Test Keys","type":"basic","updatedAt":"2025-06-21T11:50:59.000Z","pages":[],"uri":"/branches/1.0/reference/testing-keys","category":"/branches/1.0/categories/reference/Testing","parent":null},{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"testing-cards","title":"Test Cards Numbers","type":"basic","updatedAt":"2025-06-21T11:50:59.000Z","pages":[],"uri":"/branches/1.0/reference/testing-cards","category":"/branches/1.0/categories/reference/Testing","parent":null}],"title":"Testing","uri":"/branches/1.0/categories/reference/Testing"},{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"charge-response-codes","title":"Charges Response Codes","type":"basic","updatedAt":"2025-06-21T11:50:59.000Z","pages":[],"uri":"/branches/1.0/reference/charge-response-codes","category":"/branches/1.0/categories/reference/Reference codes","parent":null}],"title":"Reference codes","uri":"/branches/1.0/categories/reference/Reference codes"},{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"getting-started-with-your-api-7","title":"Getting Started With Your API","type":"basic","updatedAt":"2025-06-21T11:50:59.000Z","pages":[],"uri":"/branches/1.0/reference/getting-started-with-your-api-7","category":"/branches/1.0/categories/reference/BIN","parent":null}],"title":"BIN","uri":"/branches/1.0/categories/reference/BIN"},{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":true,"renderable":{"status":true},"slug":"download-disputes","title":"Download Disputes","type":"endpoint","updatedAt":"2025-06-21T11:50:59.000Z","api_method":"post","api_webhook":false,"pages":[],"uri":"/branches/1.0/reference/download-disputes","category":"/branches/1.0/categories/reference/DISPUTES","parent":null}],"title":"DISPUTES","uri":"/branches/1.0/categories/reference/DISPUTES"},{"pages":[{"deprecated":false,"hidden":false,"isBodyEmpty":false,"renderable":{"status":true},"slug":"getting-started-with-your-api-17","title":"Getting Started With Your API","type":"basic","updatedAt":"2025-06-21T11:50:59.000Z","pages":[],"uri":"/branches/1.0/reference/getting-started-with-your-api-17","category":"/branches/1.0/categories/reference/Tokens (Encrypted Card)","parent":null}],"title":"Tokens (Encrypted Card)","uri":"/branches/1.0/categories/reference/Tokens (Encrypted Card)"}],"branches":{"total":0,"page":1,"per_page":100,"paging":{"next":null,"previous":null,"first":"/tappayments/api-next/v2/branches?prefix=v1.0&page=1&per_page=100","last":null},"data":[],"type":"branch"},"config":{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2025-03-27","fullstory":{"enabled":true,"orgId":"FSV9A"},"liveblocks":{"copilotId":"co_11Q0l0JJlkcBhhAYUFh8s"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.422.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true},"shMigration":{"promoVideo":"","forceWaitlist":false,"migrationPreview":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}},"context":{"labs":{},"user":{},"terms":[{"_id":"609181673ecbe5000fceea45","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"},{"_id":"644a67ce58a5e3035857ee5f","term":"MID","definition":"Merchant ID"},{"_id":"65cb1bc0a5ae180057f5b1ac","term":"charge_id","definition":"Charge_id is the transaction id"},{"_id":"65cb1c46a5f15f002857ddb3","term":"destinations","definition":"Destinations in this context refer to specific entities or accounts where portions of a transaction amount are directed to a single/multiple accounts."}],"variables":{"user":{},"defaults":[{"source":"security","_id":"62e8bff18f830d02d6155225","name":"Authorization","type":"apiKey","default":"sk_test_oqAcdQztv84agVkCBZEup0Hh","apiSetting":"614aeaa22843b7000fe98330"},{"source":"security","_id":"646b514404003f0045ac6eda","name":"test","type":"apiKey","default":"test","apiSetting":"644a369fbc093f0068977db4"}]},"project":{"_id":"609181673ecbe5000fceea44","appearance":{"rdmd":{"callouts":{"useIconFont":false},"theme":{"background":"","border":"","markdownEdge":"","markdownFont":"","markdownFontSize":"","markdownLineHeight":"","markdownRadius":"","markdownText":"","markdownTitle":"","markdownTitleFont":"","mdCodeBackground":"","mdCodeFont":"","mdCodeRadius":"","mdCodeTabs":"","mdCodeText":"","tableEdges":"","tableHead":"","tableHeadText":"","tableRow":"","tableStripe":"","tableText":"","text":"","title":""}},"main_body":{"type":"links"},"colors":{"highlight":"","main":"#343740","main_alt":"#101010","header_text":"","body_highlight":"#1F88D0","custom_login_link_color":""},"typography":{"headline":"Open+Sans:400:sans-serif","body":"Open+Sans:400:sans-serif","typekit":false,"tk_key":"","tk_headline":"","tk_body":""},"header":{"style":"gradient","img":[],"img_size":"auto","img_pos":"tl","linkStyle":"buttons"},"body":{"style":"none"},"global_landing_page":{"html":"","redirect":""},"referenceLayout":"column","link_logo_to_url":false,"theme":"solid","overlay":"triangles","landing":true,"sticky":false,"hide_logo":true,"childrenAsPills":false,"subheaderStyle":"links","splitReferenceDocs":true,"logo":["https://files.readme.io/c7b8517-small-Tapcircle_gray.png","c7b8517-small-Tapcircle_gray.png",81,80,"#4c4948","https://files.readme.io/63fefd0-Tapcircle_gray.png"],"logo_white":["https://files.readme.io/cc73b8e-tap-logo-white.svg","cc73b8e-tap-logo-white.svg",300,124,"#000000","668673aa9dde7b0013e136eb"],"logo_white_use":true,"favicon":["https://files.readme.io/ab5c5ff-small-Tapcircle_gray.png","ab5c5ff-small-Tapcircle_gray.png",32,32,"#4c4948","https://files.readme.io/12da5df-Tapcircle_gray.png"],"stylesheet":"","stylesheet_hub2":"[data-color-mode=\"light\"] {\n --font-family: Roboto, -apple-system, BlinkMacSystemFont, Segoe UI, Roboto, Oxygen, Ubuntu, Cantarell, Fira Sans, Droid Sans, Helvetica Neue, sans-serif !important;\n --font-weight-bold: 400 !important;\n}\n\n.heading-text {font-weight:400 !important;}\n\n[data-color-mode=\"dark\"] {\n--color-bg-page: #101010 !important;\n --font-family: Roboto, -apple-system, BlinkMacSystemFont, Segoe UI, Roboto, Oxygen, Ubuntu, Cantarell, Fira Sans, Droid Sans, Helvetica Neue, sans-serif !important;\n --font-weight-bold: 400 !important;\n}","javascript":"","javascript_hub2":"","html_promo":"","html_body":"","html_footer":"","html_head":"","html_footer_meta":"","html_hidelinks":false,"showVersion":false,"hideTableOfContents":false,"nextStepsLabel":"","promos":[{"extras":{"type":"buttons","buttonPrimary":"reference","buttonSecondary":""},"title":"Developer documentation","text":"Developer Tools to Build Disruptive Payment Experiences","_id":"609181673ecbe5000fceea46"}],"showMetricsInReference":true,"referenceSimpleMode":true,"stylesheet_hub3":"","loginLogo":[],"logo_large":true,"colorScheme":"system","changelog":{"layoutExpanded":false,"showAuthor":true,"showExactDate":false},"allowApiExplorerJsonEditor":true,"ai_dropdown":"disabled","ai_options":{"chatgpt":"enabled","claude":"enabled","clipboard":"enabled","copilot":"enabled","perplexity":"enabled","view_as_markdown":"enabled"},"showPageIcons":true,"layout":{"full_width":false,"style":"classic"}},"custom_domain":"developers.tap.company","childrenProjects":[],"derivedPlan":"business2018","description":"","isExternalSnippetActive":false,"error404":"","experiments":[],"first_page":"landing","flags":{"allow_hub2":false,"enterprise":false,"alwaysShowDocPublishStatus":false,"hub2":true,"migrationRun":false,"migrationSwaggerRun":false,"oauth":false,"swagger":false,"correctnewlines":false,"rdmdCompatibilityMode":false,"speedyRender":false,"allowXFrame":false,"newEditor":true,"oldMarkdown":false,"useReactApp":true,"newMarkdownBetaProgram":true,"referenceRedesign":false,"disableAnonForum":false,"directGoogleToStableVersion":false,"translation":false,"staging":false,"newSearch":true,"graphql":false,"allowApiExplorerJsonEditor":false,"newHeader":false,"singleProjectEnterprise":false,"dashReact":false,"allowReferenceUpgrade":false,"metricsV2":true,"newEditorDash":true,"enableRealtimeExperiences":false,"reviewWorkflow":true,"star":false,"allowDarkMode":false,"forceDarkMode":false,"useReactGLP":false,"disablePasswordlessLogin":false,"personalizedDocs":false,"myDevelopers":false,"superHub":true,"developerDashboard":false,"allowReusableOTPs":false,"dashHomeRefresh":false,"owlbotAi":false,"apiV2":false,"git":{"read":false,"write":false},"superHubBeta":false,"dashQuickstart":false,"disableAutoTranslate":false,"customBlocks":false,"devDashHub":false,"disableSAMLScoping":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"apiAccessRevoked":false,"passwordlessLogin":"default","disableSignups":false,"billingRedesignEnabled":true,"developerPortal":false,"mdx":true,"superHubDevelopment":false,"annualBillingEnabled":true,"devDashBillingRedesignEnabled":false,"enableOidc":false,"customComponents":false,"disableDiscussionSpamRecaptchaBypass":false,"developerViewUsersData":false,"changelogRssAlwaysPublic":false,"bidiSync":true,"superHubMigrationSelfServeFlow":true,"apiDesigner":false,"hideEnforceSSO":false,"localLLM":false,"superHubManageVersions":false,"gitSidebar":false,"superHubGlobalCustomBlocks":false,"childManagedBidi":false,"superHubBranches":false,"externalSdkSnippets":false,"requiresJQuery":false,"migrationPreview":false,"superHubPreview":false,"superHubBranchReviews":false,"superHubMergePermissions":false},"fullBaseUrl":"https://developers.tap.company/","git":{"migration":{"createRepository":{"start":"2025-06-11T23:49:38.090Z","end":"2025-06-11T23:49:38.506Z","status":"successful"},"transformation":{"end":"2025-06-11T23:49:40.856Z","start":"2025-06-11T23:49:38.697Z","status":"successful"},"migratingPages":{"end":"2025-06-11T23:49:42.138Z","start":"2025-06-11T23:49:41.204Z","status":"successful"},"enableSuperhub":{"start":"2025-06-12T00:18:55.452Z","status":"successful","end":"2025-06-12T00:18:55.453Z"}},"sync":{"linked_repository":{},"installationRequest":{},"connections":[],"providers":[]}},"glossaryTerms":[{"_id":"609181673ecbe5000fceea45","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"},{"_id":"644a67ce58a5e3035857ee5f","term":"MID","definition":"Merchant ID"},{"_id":"65cb1bc0a5ae180057f5b1ac","term":"charge_id","definition":"Charge_id is the transaction id"},{"_id":"65cb1c46a5f15f002857ddb3","term":"destinations","definition":"Destinations in this context refer to specific entities or accounts where portions of a transaction amount are directed to a single/multiple accounts."}],"graphqlSchema":"","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"healthCheck":{"provider":"manual","settings":{"page":"","status":true,"url":"http://www.tap.company/"}},"intercom_secure_emailonly":false,"intercom":"","is_active":true,"integrations":{"login":{}},"internal":"","jwtExpirationTime":0,"landing_bottom":[{"type":"text-media","alignment":"left","side":"left","mediaType":"image","text":"Tap is on a mission to change how businesses and consumers in the Middle East accept and make payments online.\n\nExplore our well-documented developer docs to build powerful products with our flexible APIs.","title":"Ready to start building?","mediaImage":["https://files.readme.io/34ceb1e-tap-checkout-laptop-iphone.png","34ceb1e-tap-checkout-laptop-iphone.png",1440,917,"#000000"]},{"type":"text-media","alignment":"left","side":"right","mediaType":"image","title":"Access all local, regional, & global payment methods","text":"Your customers can scale globally by offering all popular payment methods across MENA, whether that's mada, KNET, Fawry, Apple Pay, Visa, Mastercard, Amex, Tabby, and many more.","mediaImage":["https://files.readme.io/4dc0d3e-payment-methods-tap-transparent.png","4dc0d3e-payment-methods-tap-transparent.png",1440,917,"#000000"]}],"mdxMigrationStatus":"rdmd","metrics":{"monthlyLimit":0,"thumbsEnabled":true,"usageLastChecked":"2021-05-18T11:52:25.623Z","planLimit":1000000,"realtime":{"dashEnabled":false,"hubEnabled":false},"monthlyPurchaseLimit":0,"meteredBilling":{}},"modules":{"landing":true,"docs":true,"examples":true,"reference":true,"changelog":false,"discuss":false,"suggested_edits":false,"logs":false,"custompages":false,"tutorials":false,"graphql":false},"name":"Tap API Docs 1.0","nav_names":{"docs":"","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""},"oauth_url":"","onboardingCompleted":{"documentation":true,"appearance":true,"jwt":false,"api":true,"logs":true,"domain":true,"metricsSDK":false},"owlbot":{"enabled":false,"isPaying":false,"customization":{"answerLength":"long","customTone":"","defaultAnswer":"","forbiddenWords":"","tone":"neutral"},"copilot":{"enabled":false,"hasBeenUsed":false,"installedCustomPage":""}},"owner":{"id":null,"email":null,"name":null},"plan":"business2018","planOverride":"","planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"active","planTrial":"business2018","readmeScore":{"components":{"newDesign":{"enabled":true,"points":25},"reference":{"enabled":true,"points":50},"tryItNow":{"enabled":true,"points":35},"syncingOAS":{"enabled":false,"points":10},"customLogin":{"enabled":true,"points":25},"metrics":{"enabled":false,"points":40},"recipes":{"enabled":false,"points":15},"pageVoting":{"enabled":true,"points":1},"suggestedEdits":{"enabled":false,"points":10},"support":{"enabled":false,"points":5},"htmlLanding":{"enabled":false,"points":5},"guides":{"enabled":true,"points":10},"changelog":{"enabled":false,"points":5},"glossary":{"enabled":true,"points":1},"variables":{"enabled":true,"points":1},"integrations":{"enabled":true,"points":2}},"totalScore":150},"reCaptchaSiteKey":"","reference":{"alwaysUseDefaults":true,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":false,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":false},"stable":{"_id":"609181673ecbe5000fceea49","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["609181673ecbe5000fceea4b","609181673ecbe5000fceea4b","6091b3f99674c400163bff89","6091b4039cd053001ccd75ca","6091b9cabd08070044290985","6091ccd39405f5003a584a51","6091cd389f45cb00560bfd03","6095b97114006a014f3f1d4f","6095bd6196b92a00118b459d","6095bd978a10e0006bc46b06","6095bde7c1dc50001c095fa9","6096df8e16bd240064459165","60983af7df1158001ef2eff9","60999756d42c46007b006a79","609a3ad9f4596b0050872a03","60a2bbf7f3adf5002a9ad72e","60b458201c9e210016124e07","60b459da24cfd70073180153","60b45b397314140071385c1f","60b45c0e1a9223001c137851","60b45c742dbc65002b1ccfa9","60c048f5bc086f006399b817","60c0493ea600cc005e71953a","60c0497796c2af0033eb3e4c","60c049c35d4d8a000f1cc810","60c511d4f4a6fa004573f9ba","60c7e530bf52a5007f7da43b","60c9451d403b6900502989a6","60c98862c86ae9000fbf55fc","60d7a1f88b948a002ae79f91","60e605d60fae0c000f2d243a","6138f44d0c99ef0056745ae3","614ae981229ec80062e09c91","614aeaa22843b7000fe98332","614b1f21292222023c90b303","614b22b70a462c0071358ecb","614b36dc0437a7005d3a27ac","614c0577816706007abd6e04","614c05e3b9b417000f0394f0","614c14bd0ed1aa0043a6b0bc","614c25dd49cf1b000f94557a","614c67015a05e4005eb0b229","614c68879cee70000f672ffc","614c6b72a2b5e50079ebc763","614c6ed3218f16018b270eb1","614c7646f73c16007a5a8aeb","614c7d2c2c92f3001eb10ea0","614cd14a5c65ab006915b506","614debc2daabc80041992905","614df6734993df0029e4c28a","61501840584f4d004a701a59","6150219595ff56000faf6692","6150257421f82e001800da63","6150275dbca0e4004298279e","615040c71995710018ff6da5","61504a794dd368011f2b767b","615051fd186f32002a3e7fe8","61505a219f352800437308a9","6153ecce49305f0036ccabe9","6153ecfaa256830074bc16ab","6153ed21f89c000077626b46","62a1cb5617d8250093bbbf92","6376b4a52ac94400030a8954","644a369fbc093f0068977db7","644a38f00df056000a1f7be9","644a3c522a4b60077da18217","644a3fbbdc577706e617bf5c","644a43f116cff60015341077","644a5a710734260047a5c1c0","644a5b4ee93098000e224bac","644a6270d93cb6001a427e3b","646f3e102383c2072331c68c","647991b6a0313a00129bd1fd","648788082dca3b006c55f1b7","648ae3732d238b18720af010","64e83253f6aaa5006b197201","64e832538f7a1b001eff2152","64e8325384659a000d0766e3","64edd6ce1724b40037e6fe1a","6522b6c8af0e280013431b5c","653823f82c69e10038a3e744","65389026e52461000dff867f","654374aead28ee079008c5dc","6568a3f3ba96d8003f9ea0fa","6568a56bc9523700546a9ef0","6568a5a787accf003276274f","6568a5aeae53490078c17a6c","6568a5b64b48fc00642149e6","6568a5d7dcc06700319d0e51","658d55099134010010d83873","65aced7eeae0c00064957786","65df3397c4edf7005ad80c7e","6668c34424783c005237566d","66694dbf87bcd400146ac4f9","668ff1aedcb1740059c46dbf","668ff71289edb900543cbec5","668ffaa3e1b39200315fc95f","668ffaf5bf6d8c007157b7c9","66a20c1a4afc0a004a9ae1d8","66acc94362fd700054bce0a7","66accb01de3aa400127c615f","66b46a6cdf2832002a032359","66cc86934be3ef0018b72d84","673d965f9a77b00010d6b174","676ad7a0cfc66e00119406e5","676c002f13121d0efc2c1414","67965682dc3afe0044f1e853","679659c59bb515808b5a1c5b","679c9509e0f3a50036b05069","67a9d8bc885ab100723ce638","67a9d9acceb469005ecf7f77","680214474bd36300611d90ad"],"project":"609181673ecbe5000fceea44","releaseDate":"2021-05-04T17:16:23.435Z","createdAt":"2021-05-04T17:16:23.435Z","__v":13,"updatedAt":"2025-06-21T11:38:59.830Z","pdfStatus":"complete","apiRegistries":[{"filename":"subscription.json","uuid":"pavp975ilhgaala8"},{"filename":"charges.json","uuid":"349ct10madzg8gg"},{"filename":"authorize.json","uuid":"19ijga10m79acoeg"},{"filename":"refunds.json","uuid":"dl82et2flwm5596msb"},{"filename":"tokens.json","uuid":"3i46r2hm9mkdhz6"},{"filename":"cards.json","uuid":"5eq312mbrnhuxf"},{"filename":"business.json","uuid":"1c8zg4gpm7vr3s3z"},{"filename":"wallet.json","uuid":"gh4j02tlgz22lcx"},{"filename":"bank-account.json","uuid":"rowbe8al4cryk27"},{"filename":"orders.json","uuid":"3q14mrl696q690"},{"filename":"products.json","uuid":"3qzzvi3tl47cu29u"},{"filename":"merchant.json","uuid":"13wqkvhm6un0ezg"},{"filename":"invoices.json","uuid":"4t7pm13h28ab"},{"filename":"fulfilment-provider.json","uuid":"3xilk24l47cva7j"},{"filename":"fulfilment-carrier.json","uuid":"9b42el47cvdg5"},{"filename":"carrier-aggregator.json","uuid":"3qzzvi1qcl47cvhog"},{"filename":"currency.json","uuid":"de0m3xl4dugc1p"},{"filename":"recurring.json","uuid":"9b416l47cvyto"},{"filename":"customers.json","uuid":"fi2jg2mc65fuxv"},{"filename":"users.json","uuid":"3qzzvi125l47cv6k8"},{"filename":"operator.json","uuid":"4wamrg9m6enzk9e"},{"filename":"developer.json","uuid":"55o0d20l47cw6g9"},{"filename":"dev-house.json","uuid":"3xilk3sl47cwei4"},{"filename":"files.json","uuid":"2lnj72plzkz7x76"},{"filename":"destinations.json","uuid":"4wama1um6euu8w3"},{"filename":"file-link.json","uuid":"9b41hl47cwqwd"},{"filename":"document.json","uuid":"18xlpjl47cwukq"},{"filename":"disputes.json","uuid":"15lscrgm6yzk5md"},{"filename":"entity.json","uuid":"12483h4rl47cup3h"},{"filename":"brand.json","uuid":"1dp2k221lgz1vs4c"},{"filename":"branch.json","uuid":"3qzzvikl47cuxrk"},{"filename":"token-apple-pay.json","uuid":"7co71om1p0df85"},{"filename":"tokens-saved-card.json","uuid":"a0rzzx1fvlm9mjg6jh"},{"filename":"lead.json","uuid":"87rx2rm49rik7x"},{"filename":"connect.json","uuid":"d1dm11m0113pp8"},{"filename":"payout.json","uuid":"w6ncd2ym059ijae"},{"filename":"statement.json","uuid":"p2ulzigigja"},{"filename":"lead-new.json","uuid":"75l1bm75sm3ja"},{"filename":"transfers.json","uuid":"4da2rm5qtchiu"},{"filename":"token-samsung-pay.json","uuid":"3v9bvivimm52n8bps"},{"filename":"bin.json","uuid":"aspw37m6kpipc4"},{"filename":"tokens-encrypted-card.json","uuid":"9kzom9mku6ag"}],"source":"readme"},"subdomain":"tappayments","subpath":"","superHubWaitlist":false,"topnav":{"left":[{"type":"home","text":"Home"}],"right":[{"type":"user","text":"User","url":"/login?redirect_uri=/reference/charges"}],"edited":true,"bottom":[]},"trial":{"trialDeadlineEnabled":true,"trialEndsAt":"2021-09-14T17:16:23.387Z"},"translate":{"provider":"transifex","show_widget":false,"key_public":"","org_name":"","project_name":"","languages":[]},"url":"https://www.tap.company/","versions":[{"_id":"609181673ecbe5000fceea49","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["609181673ecbe5000fceea4b","609181673ecbe5000fceea4b","6091b3f99674c400163bff89","6091b4039cd053001ccd75ca","6091b9cabd08070044290985","6091ccd39405f5003a584a51","6091cd389f45cb00560bfd03","6095b97114006a014f3f1d4f","6095bd6196b92a00118b459d","6095bd978a10e0006bc46b06","6095bde7c1dc50001c095fa9","6096df8e16bd240064459165","60983af7df1158001ef2eff9","60999756d42c46007b006a79","609a3ad9f4596b0050872a03","60a2bbf7f3adf5002a9ad72e","60b458201c9e210016124e07","60b459da24cfd70073180153","60b45b397314140071385c1f","60b45c0e1a9223001c137851","60b45c742dbc65002b1ccfa9","60c048f5bc086f006399b817","60c0493ea600cc005e71953a","60c0497796c2af0033eb3e4c","60c049c35d4d8a000f1cc810","60c511d4f4a6fa004573f9ba","60c7e530bf52a5007f7da43b","60c9451d403b6900502989a6","60c98862c86ae9000fbf55fc","60d7a1f88b948a002ae79f91","60e605d60fae0c000f2d243a","6138f44d0c99ef0056745ae3","614ae981229ec80062e09c91","614aeaa22843b7000fe98332","614b1f21292222023c90b303","614b22b70a462c0071358ecb","614b36dc0437a7005d3a27ac","614c0577816706007abd6e04","614c05e3b9b417000f0394f0","614c14bd0ed1aa0043a6b0bc","614c25dd49cf1b000f94557a","614c67015a05e4005eb0b229","614c68879cee70000f672ffc","614c6b72a2b5e50079ebc763","614c6ed3218f16018b270eb1","614c7646f73c16007a5a8aeb","614c7d2c2c92f3001eb10ea0","614cd14a5c65ab006915b506","614debc2daabc80041992905","614df6734993df0029e4c28a","61501840584f4d004a701a59","6150219595ff56000faf6692","6150257421f82e001800da63","6150275dbca0e4004298279e","615040c71995710018ff6da5","61504a794dd368011f2b767b","615051fd186f32002a3e7fe8","61505a219f352800437308a9","6153ecce49305f0036ccabe9","6153ecfaa256830074bc16ab","6153ed21f89c000077626b46","62a1cb5617d8250093bbbf92","6376b4a52ac94400030a8954","644a369fbc093f0068977db7","644a38f00df056000a1f7be9","644a3c522a4b60077da18217","644a3fbbdc577706e617bf5c","644a43f116cff60015341077","644a5a710734260047a5c1c0","644a5b4ee93098000e224bac","644a6270d93cb6001a427e3b","646f3e102383c2072331c68c","647991b6a0313a00129bd1fd","648788082dca3b006c55f1b7","648ae3732d238b18720af010","64e83253f6aaa5006b197201","64e832538f7a1b001eff2152","64e8325384659a000d0766e3","64edd6ce1724b40037e6fe1a","6522b6c8af0e280013431b5c","653823f82c69e10038a3e744","65389026e52461000dff867f","654374aead28ee079008c5dc","6568a3f3ba96d8003f9ea0fa","6568a56bc9523700546a9ef0","6568a5a787accf003276274f","6568a5aeae53490078c17a6c","6568a5b64b48fc00642149e6","6568a5d7dcc06700319d0e51","658d55099134010010d83873","65aced7eeae0c00064957786","65df3397c4edf7005ad80c7e","6668c34424783c005237566d","66694dbf87bcd400146ac4f9","668ff1aedcb1740059c46dbf","668ff71289edb900543cbec5","668ffaa3e1b39200315fc95f","668ffaf5bf6d8c007157b7c9","66a20c1a4afc0a004a9ae1d8","66acc94362fd700054bce0a7","66accb01de3aa400127c615f","66b46a6cdf2832002a032359","66cc86934be3ef0018b72d84","673d965f9a77b00010d6b174","676ad7a0cfc66e00119406e5","676c002f13121d0efc2c1414","67965682dc3afe0044f1e853","679659c59bb515808b5a1c5b","679c9509e0f3a50036b05069","67a9d8bc885ab100723ce638","67a9d9acceb469005ecf7f77","680214474bd36300611d90ad"],"project":"609181673ecbe5000fceea44","releaseDate":"2021-05-04T17:16:23.435Z","createdAt":"2021-05-04T17:16:23.435Z","__v":13,"updatedAt":"2025-06-21T11:38:59.830Z","pdfStatus":"complete","apiRegistries":[{"filename":"subscription.json","uuid":"pavp975ilhgaala8"},{"filename":"charges.json","uuid":"349ct10madzg8gg"},{"filename":"authorize.json","uuid":"19ijga10m79acoeg"},{"filename":"refunds.json","uuid":"dl82et2flwm5596msb"},{"filename":"tokens.json","uuid":"3i46r2hm9mkdhz6"},{"filename":"cards.json","uuid":"5eq312mbrnhuxf"},{"filename":"business.json","uuid":"1c8zg4gpm7vr3s3z"},{"filename":"wallet.json","uuid":"gh4j02tlgz22lcx"},{"filename":"bank-account.json","uuid":"rowbe8al4cryk27"},{"filename":"orders.json","uuid":"3q14mrl696q690"},{"filename":"products.json","uuid":"3qzzvi3tl47cu29u"},{"filename":"merchant.json","uuid":"13wqkvhm6un0ezg"},{"filename":"invoices.json","uuid":"4t7pm13h28ab"},{"filename":"fulfilment-provider.json","uuid":"3xilk24l47cva7j"},{"filename":"fulfilment-carrier.json","uuid":"9b42el47cvdg5"},{"filename":"carrier-aggregator.json","uuid":"3qzzvi1qcl47cvhog"},{"filename":"currency.json","uuid":"de0m3xl4dugc1p"},{"filename":"recurring.json","uuid":"9b416l47cvyto"},{"filename":"customers.json","uuid":"fi2jg2mc65fuxv"},{"filename":"users.json","uuid":"3qzzvi125l47cv6k8"},{"filename":"operator.json","uuid":"4wamrg9m6enzk9e"},{"filename":"developer.json","uuid":"55o0d20l47cw6g9"},{"filename":"dev-house.json","uuid":"3xilk3sl47cwei4"},{"filename":"files.json","uuid":"2lnj72plzkz7x76"},{"filename":"destinations.json","uuid":"4wama1um6euu8w3"},{"filename":"file-link.json","uuid":"9b41hl47cwqwd"},{"filename":"document.json","uuid":"18xlpjl47cwukq"},{"filename":"disputes.json","uuid":"15lscrgm6yzk5md"},{"filename":"entity.json","uuid":"12483h4rl47cup3h"},{"filename":"brand.json","uuid":"1dp2k221lgz1vs4c"},{"filename":"branch.json","uuid":"3qzzvikl47cuxrk"},{"filename":"token-apple-pay.json","uuid":"7co71om1p0df85"},{"filename":"tokens-saved-card.json","uuid":"a0rzzx1fvlm9mjg6jh"},{"filename":"lead.json","uuid":"87rx2rm49rik7x"},{"filename":"connect.json","uuid":"d1dm11m0113pp8"},{"filename":"payout.json","uuid":"w6ncd2ym059ijae"},{"filename":"statement.json","uuid":"p2ulzigigja"},{"filename":"lead-new.json","uuid":"75l1bm75sm3ja"},{"filename":"transfers.json","uuid":"4da2rm5qtchiu"},{"filename":"token-samsung-pay.json","uuid":"3v9bvivimm52n8bps"},{"filename":"bin.json","uuid":"aspw37m6kpipc4"},{"filename":"tokens-encrypted-card.json","uuid":"9kzom9mku6ag"}],"source":"readme"},{"_id":"644a70bd812ae70050038744","version":"1.1","version_clean":"1.1.0","codename":"v1.1","is_stable":false,"is_beta":true,"is_hidden":true,"is_deprecated":false,"categories":["609181673ecbe5000fceea4b","609181673ecbe5000fceea4b","6091b3f99674c400163bff89","6091b4039cd053001ccd75ca","644a70bd812ae70050038622","644a70bd812ae70050038623","644a70bd812ae70050038624","644a70bd812ae70050038625","6095bd6196b92a00118b459d","6095bd978a10e0006bc46b06","6095bde7c1dc50001c095fa9","6096df8e16bd240064459165","644a70bd812ae70050038626","644a70bd812ae70050038627","644a70bd812ae70050038628","644a70bd812ae70050038629","60b458201c9e210016124e07","60b459da24cfd70073180153","60b45b397314140071385c1f","60b45c0e1a9223001c137851","60b45c742dbc65002b1ccfa9","60c048f5bc086f006399b817","60c0493ea600cc005e71953a","60c0497796c2af0033eb3e4c","60c049c35d4d8a000f1cc810","644a70bd812ae7005003862a","644a70bd812ae7005003862b","644a70bd812ae7005003862c","60c98862c86ae9000fbf55fc","644a70bd812ae7005003862d","60e605d60fae0c000f2d243a","644a70bd812ae7005003862e","614ae981229ec80062e09c91","644a70bd812ae7005003862f","614b1f21292222023c90b303","644a70bd812ae70050038630","644a70bd812ae70050038631","614c0577816706007abd6e04","614c05e3b9b417000f0394f0","614c14bd0ed1aa0043a6b0bc","614c25dd49cf1b000f94557a","644a70bd812ae70050038632","614c68879cee70000f672ffc","614c6b72a2b5e50079ebc763","644a70bd812ae70050038633","644a70bd812ae70050038634","614c7d2c2c92f3001eb10ea0","644a70bd812ae70050038635","614debc2daabc80041992905","614df6734993df0029e4c28a","61501840584f4d004a701a59","6150219595ff56000faf6692","6150257421f82e001800da63","644a70bd812ae70050038636","615040c71995710018ff6da5","61504a794dd368011f2b767b","615051fd186f32002a3e7fe8","61505a219f352800437308a9","6153ecce49305f0036ccabe9","6153ecfaa256830074bc16ab","6153ed21f89c000077626b46","644a70bd812ae70050038637","6376b4a52ac94400030a8954","644a369fbc093f0068977db7","644a38f00df056000a1f7be9","644a70bd812ae70050038638","644a3fbbdc577706e617bf5c","644a43f116cff60015341077","644a5a710734260047a5c1c0","644a70bd812ae70050038639","644a70bd812ae7005003863a","644a70be812ae70050038748","6489964737cd94004d8de976","6568a3be3dc23e006b7666f3"],"project":"609181673ecbe5000fceea44","releaseDate":"2021-05-04T17:16:23.435Z","createdAt":"2021-05-04T17:16:23.435Z","__v":1,"forked_from":"609181673ecbe5000fceea49","updatedAt":"2025-06-11T23:49:37.880Z","apiRegistries":[{"filename":"subscription.json","uuid":"b6gv13l47hrwt4"},{"filename":"create-a-charge.json","uuid":"3uimz3dlgyve3o1"},{"filename":"retrieve-a-charge.json","uuid":"7mu3pu1ykpvf43zg"},{"filename":"authorize.json","uuid":"2ljr53cl372tgl3"},{"filename":"list-all-charges.json","uuid":"1mld74kq6wk65u"},{"filename":"charges.json","uuid":"gh4j027ulgz0w4ja"},{"filename":"refunds.json","uuid":"3xilk1cl47csx66"},{"filename":"cards.json","uuid":"9b413l46zg22f"},{"filename":"wallet.json","uuid":"gh4j02tlgz22lcx"},{"filename":"merchant.json","uuid":"3qzzvi1pl47cuckn"},{"filename":"tokens.json","uuid":"16vcze2tlgz28gql"},{"filename":"fulfilment-provider.json","uuid":"3xilk24l47cva7j"},{"filename":"products.json","uuid":"3qzzvi3tl47cu29u"},{"filename":"bank-account.json","uuid":"rowbe8al4cryk27"},{"filename":"business.json","uuid":"j3gu10lgz3bs7h"},{"filename":"orders.json","uuid":"3q14mrl696q690"},{"filename":"fulfilment-carrier.json","uuid":"9b42el47cvdg5"},{"filename":"invoices.json","uuid":"55o0d2gl47cu610"},{"filename":"billing.json"},{"filename":"carrier-aggregator.json","uuid":"3qzzvi1qcl47cvhog"},{"filename":"currency.json","uuid":"de0m3xl4dugc1p"},{"filename":"customers.json","uuid":"sxbqhm94pl47cv1y7"},{"filename":"users.json","uuid":"3qzzvi125l47cv6k8"},{"filename":"operator.json","uuid":"3uimz1jalgz3r91f"},{"filename":"recurring.json","uuid":"9b416l47cvyto"},{"filename":"entity.json","uuid":"12483h4rl47cup3h"},{"filename":"destination.json","uuid":"55o0d4kl47cugy3"},{"filename":"token-apple-pay.json","uuid":"1dp2k22olgywf8fv"},{"filename":"file-link.json","uuid":"9b41hl47cwqwd"},{"filename":"developer.json","uuid":"55o0d20l47cw6g9"},{"filename":"document.json","uuid":"18xlpjl47cwukq"},{"filename":"branch.json","uuid":"3qzzvikl47cuxrk"},{"filename":"brand.json","uuid":"1dp2k221lgz1vs4c"},{"filename":"files.json","uuid":"gh4j02drlgz3lxkk"},{"filename":"dev-house.json","uuid":"3xilk3sl47cwei4"},{"filename":"disputes.json"},{"filename":"tokens-saved-card.json","uuid":"22qv752ylgyzzx2y"}],"pdfStatus":"","source":"readme"}],"variableDefaults":[{"source":"security","_id":"62e8bff18f830d02d6155225","name":"Authorization","type":"apiKey","default":"sk_test_oqAcdQztv84agVkCBZEup0Hh","apiSetting":"614aeaa22843b7000fe98330"},{"source":"security","_id":"646b514404003f0045ac6eda","name":"test","type":"apiKey","default":"test","apiSetting":"644a369fbc093f0068977db4"}],"webhookEnabled":false,"isHubEditable":true},"projectStore":{"data":{"allow_crawlers":"disabled","canonical_url":null,"default_version":{"name":"1.0"},"description":null,"glossary":[{"_id":"609181673ecbe5000fceea45","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"},{"_id":"644a67ce58a5e3035857ee5f","term":"MID","definition":"Merchant ID"},{"_id":"65cb1bc0a5ae180057f5b1ac","term":"charge_id","definition":"Charge_id is the transaction id"},{"_id":"65cb1c46a5f15f002857ddb3","term":"destinations","definition":"Destinations in this context refer to specific entities or accounts where portions of a transaction amount are directed to a single/multiple accounts."}],"homepage_url":"https://www.tap.company/","id":"609181673ecbe5000fceea44","name":"Tap API Docs 1.0","parent":null,"redirects":[],"sitemap":"disabled","llms_txt":"disabled","subdomain":"tappayments","suggested_edits":"disabled","uri":"/projects/me","variable_defaults":[{"name":"Authorization","default":"sk_test_oqAcdQztv84agVkCBZEup0Hh","source":"security","type":"apiKey","id":"62e8bff18f830d02d6155225"},{"name":"test","default":"test","source":"security","type":"apiKey","id":"646b514404003f0045ac6eda"}],"webhooks":[],"api_designer":{"allow_editing":"enabled"},"custom_login":{"login_url":null,"logout_url":null},"features":{"mdx":"enabled"},"mcp":{},"onboarding_completed":{"api":true,"appearance":true,"documentation":true,"domain":true,"jwt":false,"logs":true,"metricsSDK":false},"pages":{"not_found":null},"privacy":{"openapi":"admin","password":null,"view":"public"},"refactored":{"status":"enabled","migrated":"successful"},"seo":{"overwrite_title_tag":"disabled"},"plan":{"type":"business2018","grace_period":{"enabled":false,"end_date":null},"trial":{"expired":false,"end_date":"2021-09-14T17:16:23.387Z"}},"reference":{"api_sdk_snippets":"enabled","defaults":"always_use","json_editor":"enabled","oauth_flows":"disabled","request_history":"enabled","response_examples":"collapsed","response_schemas":"collapsed","sdk_snippets":{"external":"disabled"}},"health_check":{"provider":"manual","settings":{"manual":{"status":"up","url":"http://www.tap.company/"},"statuspage":{"id":null}}},"integrations":{"aws":{"readme_webhook_login":{"region":null,"external_id":null,"role_arn":null,"usage_plan_id":null}},"bing":{"verify":null},"google":{"analytics":null,"site_verification":null},"heap":{"id":null},"koala":{"key":null},"localize":{"key":null},"postman":{"key":null,"client_id":null,"client_secret":null},"recaptcha":{"site_key":null,"secret_key":null},"segment":{"key":null,"domain":null},"speakeasy":{"key":null,"spec_url":null},"stainless":{"key":null,"name":null},"typekit":{"key":null},"zendesk":{"subdomain":null},"intercom":{"app_id":null,"secure_mode":{"key":null,"email_only":false}}},"permissions":{"appearance":{"private_label":"enabled","custom_code":{"css":"enabled","html":"enabled","js":"disabled"}},"branches":{"merge":{"admin":true}}},"appearance":{"brand":{"primary_color":"#343740","link_color":"#1F88D0","theme":"system"},"changelog":{"layout":"collapsed","show_author":true,"show_exact_date":false},"layout":{"full_width":"disabled","style":"classic"},"markdown":{"callouts":{"icon_font":"emojis"}},"table_of_contents":"enabled","whats_next_label":null,"footer":{"readme_logo":"hide"},"logo":{"size":"large","dark_mode":{"uri":null,"url":"https://files.readme.io/cc73b8e-tap-logo-white.svg","name":"cc73b8e-tap-logo-white.svg","width":300,"height":124,"color":"#000000","links":{"original_url":null}},"main":{"uri":null,"url":"https://files.readme.io/c7b8517-small-Tapcircle_gray.png","name":"c7b8517-small-Tapcircle_gray.png","width":81,"height":80,"color":"#4c4948","links":{"original_url":"https://files.readme.io/63fefd0-Tapcircle_gray.png"}},"favicon":{"uri":null,"url":"https://files.readme.io/ab5c5ff-small-Tapcircle_gray.png","name":"ab5c5ff-small-Tapcircle_gray.png","width":32,"height":32,"color":"#4c4948","links":{"original_url":"https://files.readme.io/12da5df-Tapcircle_gray.png"}}},"custom_code":{"css":"[data-color-mode=\"light\"] {\n --font-family: Roboto, -apple-system, BlinkMacSystemFont, Segoe UI, Roboto, Oxygen, Ubuntu, Cantarell, Fira Sans, Droid Sans, Helvetica Neue, sans-serif !important;\n --font-weight-bold: 400 !important;\n}\n\n.heading-text {font-weight:400 !important;}\n\n[data-color-mode=\"dark\"] {\n--color-bg-page: #101010 !important;\n --font-family: Roboto, -apple-system, BlinkMacSystemFont, Segoe UI, Roboto, Oxygen, Ubuntu, Cantarell, Fira Sans, Droid Sans, Helvetica Neue, sans-serif !important;\n --font-weight-bold: 400 !important;\n}","js":null,"html":{"header":null,"home_footer":null,"page_footer":null}},"header":{"type":"gradient","gradient_color":"#101010","link_style":"buttons","overlay":{"fill":"auto","type":"triangles","position":"top-left","image":{"uri":null,"url":null,"name":null,"width":null,"height":null,"color":null,"links":{"original_url":null}}}},"ai":{"dropdown":"disabled","options":{"chatgpt":"enabled","claude":"enabled","clipboard":"enabled","copilot":"enabled","view_as_markdown":"enabled"}},"navigation":{"first_page":"landing_page","left":[{"type":"home","title":null,"url":null,"custom_page":null}],"logo_link":"landing_page","page_icons":"enabled","right":[{"type":"user_controls","title":null,"url":null,"custom_page":null}],"sub_nav":[],"subheader_layout":"links","version":"disabled","links":{"home":{"label":"Home","visibility":"enabled"},"graphql":{"label":"GraphQL","visibility":"disabled"},"guides":{"label":"Guides","alias":null,"visibility":"enabled"},"reference":{"label":"API Reference","alias":null,"visibility":"enabled"},"recipes":{"label":"Recipes","alias":null,"visibility":"disabled"},"changelog":{"label":"Changelog","alias":null,"visibility":"disabled"},"discussions":{"label":"Discussions","alias":null,"visibility":"disabled"}}}},"git":{"connection":{"repository":{},"organization":null,"status":"inactive"}}}},"version":{"_id":"609181673ecbe5000fceea49","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["609181673ecbe5000fceea4b","609181673ecbe5000fceea4b","6091b3f99674c400163bff89","6091b4039cd053001ccd75ca","6091b9cabd08070044290985","6091ccd39405f5003a584a51","6091cd389f45cb00560bfd03","6095b97114006a014f3f1d4f","6095bd6196b92a00118b459d","6095bd978a10e0006bc46b06","6095bde7c1dc50001c095fa9","6096df8e16bd240064459165","60983af7df1158001ef2eff9","60999756d42c46007b006a79","609a3ad9f4596b0050872a03","60a2bbf7f3adf5002a9ad72e","60b458201c9e210016124e07","60b459da24cfd70073180153","60b45b397314140071385c1f","60b45c0e1a9223001c137851","60b45c742dbc65002b1ccfa9","60c048f5bc086f006399b817","60c0493ea600cc005e71953a","60c0497796c2af0033eb3e4c","60c049c35d4d8a000f1cc810","60c511d4f4a6fa004573f9ba","60c7e530bf52a5007f7da43b","60c9451d403b6900502989a6","60c98862c86ae9000fbf55fc","60d7a1f88b948a002ae79f91","60e605d60fae0c000f2d243a","6138f44d0c99ef0056745ae3","614ae981229ec80062e09c91","614aeaa22843b7000fe98332","614b1f21292222023c90b303","614b22b70a462c0071358ecb","614b36dc0437a7005d3a27ac","614c0577816706007abd6e04","614c05e3b9b417000f0394f0","614c14bd0ed1aa0043a6b0bc","614c25dd49cf1b000f94557a","614c67015a05e4005eb0b229","614c68879cee70000f672ffc","614c6b72a2b5e50079ebc763","614c6ed3218f16018b270eb1","614c7646f73c16007a5a8aeb","614c7d2c2c92f3001eb10ea0","614cd14a5c65ab006915b506","614debc2daabc80041992905","614df6734993df0029e4c28a","61501840584f4d004a701a59","6150219595ff56000faf6692","6150257421f82e001800da63","6150275dbca0e4004298279e","615040c71995710018ff6da5","61504a794dd368011f2b767b","615051fd186f32002a3e7fe8","61505a219f352800437308a9","6153ecce49305f0036ccabe9","6153ecfaa256830074bc16ab","6153ed21f89c000077626b46","62a1cb5617d8250093bbbf92","6376b4a52ac94400030a8954","644a369fbc093f0068977db7","644a38f00df056000a1f7be9","644a3c522a4b60077da18217","644a3fbbdc577706e617bf5c","644a43f116cff60015341077","644a5a710734260047a5c1c0","644a5b4ee93098000e224bac","644a6270d93cb6001a427e3b","646f3e102383c2072331c68c","647991b6a0313a00129bd1fd","648788082dca3b006c55f1b7","648ae3732d238b18720af010","64e83253f6aaa5006b197201","64e832538f7a1b001eff2152","64e8325384659a000d0766e3","64edd6ce1724b40037e6fe1a","6522b6c8af0e280013431b5c","653823f82c69e10038a3e744","65389026e52461000dff867f","654374aead28ee079008c5dc","6568a3f3ba96d8003f9ea0fa","6568a56bc9523700546a9ef0","6568a5a787accf003276274f","6568a5aeae53490078c17a6c","6568a5b64b48fc00642149e6","6568a5d7dcc06700319d0e51","658d55099134010010d83873","65aced7eeae0c00064957786","65df3397c4edf7005ad80c7e","6668c34424783c005237566d","66694dbf87bcd400146ac4f9","668ff1aedcb1740059c46dbf","668ff71289edb900543cbec5","668ffaa3e1b39200315fc95f","668ffaf5bf6d8c007157b7c9","66a20c1a4afc0a004a9ae1d8","66acc94362fd700054bce0a7","66accb01de3aa400127c615f","66b46a6cdf2832002a032359","66cc86934be3ef0018b72d84","673d965f9a77b00010d6b174","676ad7a0cfc66e00119406e5","676c002f13121d0efc2c1414","67965682dc3afe0044f1e853","679659c59bb515808b5a1c5b","679c9509e0f3a50036b05069","67a9d8bc885ab100723ce638","67a9d9acceb469005ecf7f77","680214474bd36300611d90ad"],"project":"609181673ecbe5000fceea44","releaseDate":"2021-05-04T17:16:23.435Z","createdAt":"2021-05-04T17:16:23.435Z","__v":13,"updatedAt":"2025-06-21T11:38:59.830Z","pdfStatus":"complete","apiRegistries":[{"filename":"subscription.json","uuid":"pavp975ilhgaala8"},{"filename":"charges.json","uuid":"349ct10madzg8gg"},{"filename":"authorize.json","uuid":"19ijga10m79acoeg"},{"filename":"refunds.json","uuid":"dl82et2flwm5596msb"},{"filename":"tokens.json","uuid":"3i46r2hm9mkdhz6"},{"filename":"cards.json","uuid":"5eq312mbrnhuxf"},{"filename":"business.json","uuid":"1c8zg4gpm7vr3s3z"},{"filename":"wallet.json","uuid":"gh4j02tlgz22lcx"},{"filename":"bank-account.json","uuid":"rowbe8al4cryk27"},{"filename":"orders.json","uuid":"3q14mrl696q690"},{"filename":"products.json","uuid":"3qzzvi3tl47cu29u"},{"filename":"merchant.json","uuid":"13wqkvhm6un0ezg"},{"filename":"invoices.json","uuid":"4t7pm13h28ab"},{"filename":"fulfilment-provider.json","uuid":"3xilk24l47cva7j"},{"filename":"fulfilment-carrier.json","uuid":"9b42el47cvdg5"},{"filename":"carrier-aggregator.json","uuid":"3qzzvi1qcl47cvhog"},{"filename":"currency.json","uuid":"de0m3xl4dugc1p"},{"filename":"recurring.json","uuid":"9b416l47cvyto"},{"filename":"customers.json","uuid":"fi2jg2mc65fuxv"},{"filename":"users.json","uuid":"3qzzvi125l47cv6k8"},{"filename":"operator.json","uuid":"4wamrg9m6enzk9e"},{"filename":"developer.json","uuid":"55o0d20l47cw6g9"},{"filename":"dev-house.json","uuid":"3xilk3sl47cwei4"},{"filename":"files.json","uuid":"2lnj72plzkz7x76"},{"filename":"destinations.json","uuid":"4wama1um6euu8w3"},{"filename":"file-link.json","uuid":"9b41hl47cwqwd"},{"filename":"document.json","uuid":"18xlpjl47cwukq"},{"filename":"disputes.json","uuid":"15lscrgm6yzk5md"},{"filename":"entity.json","uuid":"12483h4rl47cup3h"},{"filename":"brand.json","uuid":"1dp2k221lgz1vs4c"},{"filename":"branch.json","uuid":"3qzzvikl47cuxrk"},{"filename":"token-apple-pay.json","uuid":"7co71om1p0df85"},{"filename":"tokens-saved-card.json","uuid":"a0rzzx1fvlm9mjg6jh"},{"filename":"lead.json","uuid":"87rx2rm49rik7x"},{"filename":"connect.json","uuid":"d1dm11m0113pp8"},{"filename":"payout.json","uuid":"w6ncd2ym059ijae"},{"filename":"statement.json","uuid":"p2ulzigigja"},{"filename":"lead-new.json","uuid":"75l1bm75sm3ja"},{"filename":"transfers.json","uuid":"4da2rm5qtchiu"},{"filename":"token-samsung-pay.json","uuid":"3v9bvivimm52n8bps"},{"filename":"bin.json","uuid":"aspw37m6kpipc4"},{"filename":"tokens-encrypted-card.json","uuid":"9kzom9mku6ag"}],"source":"readme"}},"is404":false,"isDetachedProductionSite":false,"lang":"en","langFull":"Default","reqUrl":"/reference/charges","version":{"_id":"609181673ecbe5000fceea49","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["609181673ecbe5000fceea4b","609181673ecbe5000fceea4b","6091b3f99674c400163bff89","6091b4039cd053001ccd75ca","6091b9cabd08070044290985","6091ccd39405f5003a584a51","6091cd389f45cb00560bfd03","6095b97114006a014f3f1d4f","6095bd6196b92a00118b459d","6095bd978a10e0006bc46b06","6095bde7c1dc50001c095fa9","6096df8e16bd240064459165","60983af7df1158001ef2eff9","60999756d42c46007b006a79","609a3ad9f4596b0050872a03","60a2bbf7f3adf5002a9ad72e","60b458201c9e210016124e07","60b459da24cfd70073180153","60b45b397314140071385c1f","60b45c0e1a9223001c137851","60b45c742dbc65002b1ccfa9","60c048f5bc086f006399b817","60c0493ea600cc005e71953a","60c0497796c2af0033eb3e4c","60c049c35d4d8a000f1cc810","60c511d4f4a6fa004573f9ba","60c7e530bf52a5007f7da43b","60c9451d403b6900502989a6","60c98862c86ae9000fbf55fc","60d7a1f88b948a002ae79f91","60e605d60fae0c000f2d243a","6138f44d0c99ef0056745ae3","614ae981229ec80062e09c91","614aeaa22843b7000fe98332","614b1f21292222023c90b303","614b22b70a462c0071358ecb","614b36dc0437a7005d3a27ac","614c0577816706007abd6e04","614c05e3b9b417000f0394f0","614c14bd0ed1aa0043a6b0bc","614c25dd49cf1b000f94557a","614c67015a05e4005eb0b229","614c68879cee70000f672ffc","614c6b72a2b5e50079ebc763","614c6ed3218f16018b270eb1","614c7646f73c16007a5a8aeb","614c7d2c2c92f3001eb10ea0","614cd14a5c65ab006915b506","614debc2daabc80041992905","614df6734993df0029e4c28a","61501840584f4d004a701a59","6150219595ff56000faf6692","6150257421f82e001800da63","6150275dbca0e4004298279e","615040c71995710018ff6da5","61504a794dd368011f2b767b","615051fd186f32002a3e7fe8","61505a219f352800437308a9","6153ecce49305f0036ccabe9","6153ecfaa256830074bc16ab","6153ed21f89c000077626b46","62a1cb5617d8250093bbbf92","6376b4a52ac94400030a8954","644a369fbc093f0068977db7","644a38f00df056000a1f7be9","644a3c522a4b60077da18217","644a3fbbdc577706e617bf5c","644a43f116cff60015341077","644a5a710734260047a5c1c0","644a5b4ee93098000e224bac","644a6270d93cb6001a427e3b","646f3e102383c2072331c68c","647991b6a0313a00129bd1fd","648788082dca3b006c55f1b7","648ae3732d238b18720af010","64e83253f6aaa5006b197201","64e832538f7a1b001eff2152","64e8325384659a000d0766e3","64edd6ce1724b40037e6fe1a","6522b6c8af0e280013431b5c","653823f82c69e10038a3e744","65389026e52461000dff867f","654374aead28ee079008c5dc","6568a3f3ba96d8003f9ea0fa","6568a56bc9523700546a9ef0","6568a5a787accf003276274f","6568a5aeae53490078c17a6c","6568a5b64b48fc00642149e6","6568a5d7dcc06700319d0e51","658d55099134010010d83873","65aced7eeae0c00064957786","65df3397c4edf7005ad80c7e","6668c34424783c005237566d","66694dbf87bcd400146ac4f9","668ff1aedcb1740059c46dbf","668ff71289edb900543cbec5","668ffaa3e1b39200315fc95f","668ffaf5bf6d8c007157b7c9","66a20c1a4afc0a004a9ae1d8","66acc94362fd700054bce0a7","66accb01de3aa400127c615f","66b46a6cdf2832002a032359","66cc86934be3ef0018b72d84","673d965f9a77b00010d6b174","676ad7a0cfc66e00119406e5","676c002f13121d0efc2c1414","67965682dc3afe0044f1e853","679659c59bb515808b5a1c5b","679c9509e0f3a50036b05069","67a9d8bc885ab100723ce638","67a9d9acceb469005ecf7f77","680214474bd36300611d90ad"],"project":"609181673ecbe5000fceea44","releaseDate":"2021-05-04T17:16:23.435Z","createdAt":"2021-05-04T17:16:23.435Z","__v":13,"updatedAt":"2025-06-21T11:38:59.830Z","pdfStatus":"complete","apiRegistries":[{"filename":"subscription.json","uuid":"pavp975ilhgaala8"},{"filename":"charges.json","uuid":"349ct10madzg8gg"},{"filename":"authorize.json","uuid":"19ijga10m79acoeg"},{"filename":"refunds.json","uuid":"dl82et2flwm5596msb"},{"filename":"tokens.json","uuid":"3i46r2hm9mkdhz6"},{"filename":"cards.json","uuid":"5eq312mbrnhuxf"},{"filename":"business.json","uuid":"1c8zg4gpm7vr3s3z"},{"filename":"wallet.json","uuid":"gh4j02tlgz22lcx"},{"filename":"bank-account.json","uuid":"rowbe8al4cryk27"},{"filename":"orders.json","uuid":"3q14mrl696q690"},{"filename":"products.json","uuid":"3qzzvi3tl47cu29u"},{"filename":"merchant.json","uuid":"13wqkvhm6un0ezg"},{"filename":"invoices.json","uuid":"4t7pm13h28ab"},{"filename":"fulfilment-provider.json","uuid":"3xilk24l47cva7j"},{"filename":"fulfilment-carrier.json","uuid":"9b42el47cvdg5"},{"filename":"carrier-aggregator.json","uuid":"3qzzvi1qcl47cvhog"},{"filename":"currency.json","uuid":"de0m3xl4dugc1p"},{"filename":"recurring.json","uuid":"9b416l47cvyto"},{"filename":"customers.json","uuid":"fi2jg2mc65fuxv"},{"filename":"users.json","uuid":"3qzzvi125l47cv6k8"},{"filename":"operator.json","uuid":"4wamrg9m6enzk9e"},{"filename":"developer.json","uuid":"55o0d20l47cw6g9"},{"filename":"dev-house.json","uuid":"3xilk3sl47cwei4"},{"filename":"files.json","uuid":"2lnj72plzkz7x76"},{"filename":"destinations.json","uuid":"4wama1um6euu8w3"},{"filename":"file-link.json","uuid":"9b41hl47cwqwd"},{"filename":"document.json","uuid":"18xlpjl47cwukq"},{"filename":"disputes.json","uuid":"15lscrgm6yzk5md"},{"filename":"entity.json","uuid":"12483h4rl47cup3h"},{"filename":"brand.json","uuid":"1dp2k221lgz1vs4c"},{"filename":"branch.json","uuid":"3qzzvikl47cuxrk"},{"filename":"token-apple-pay.json","uuid":"7co71om1p0df85"},{"filename":"tokens-saved-card.json","uuid":"a0rzzx1fvlm9mjg6jh"},{"filename":"lead.json","uuid":"87rx2rm49rik7x"},{"filename":"connect.json","uuid":"d1dm11m0113pp8"},{"filename":"payout.json","uuid":"w6ncd2ym059ijae"},{"filename":"statement.json","uuid":"p2ulzigigja"},{"filename":"lead-new.json","uuid":"75l1bm75sm3ja"},{"filename":"transfers.json","uuid":"4da2rm5qtchiu"},{"filename":"token-samsung-pay.json","uuid":"3v9bvivimm52n8bps"},{"filename":"bin.json","uuid":"aspw37m6kpipc4"},{"filename":"tokens-encrypted-card.json","uuid":"9kzom9mku6ag"}],"source":"readme"},"gitVersion":{"base":null,"display_name":null,"name":"1.0","release_stage":"beta","source":"readme","state":"current","updated_at":"2025-07-17T14:59:25.000Z","uri":"/branches/1.0","privacy":{"view":"default"}},"versions":{"total":2,"page":1,"per_page":100,"paging":{"next":null,"previous":null,"first":"/tappayments/api-next/v2/branches?page=1&per_page=100","last":null},"data":[{"base":null,"display_name":null,"name":"1.0","release_stage":"beta","source":"readme","state":"current","updated_at":"2025-07-17T14:59:25.323Z","uri":"/branches/1.0","privacy":{"view":"default"}},{"base":"1.0","display_name":"v1.1","name":"1.1","release_stage":"beta","source":"readme","state":"current","updated_at":"2025-06-16T13:38:18.010Z","uri":"/branches/1.1","privacy":{"view":"hidden"}}],"type":"version"}}">
