Getting Started with BitPay

<!DOCTYPE html><html lang="en" style="" data-color-mode="system" class=" useReactApp "><head><script src="https://cdn.readme.io/public/js/force-firefox-anchor-jump.js?1732290089794"></script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="readme-deploy" content="5.235.0"><meta name="readme-subdomain" content="bitpay"><meta name="readme-version" content="1.0"><title>Getting Started with BitPay</title><meta name="description" content="This page will help you get started with BitPay. You'll be up and running in a jiffy!"><meta property="og:title" content="Getting Started with BitPay"><meta property="og:description" content="This page will help you get started with BitPay. You'll be up and running in a jiffy!"><meta property="og:site_name" content="bitpay"><meta name="twitter:title" content="Getting Started with BitPay"><meta name="twitter:description" content="This page will help you get started with BitPay. You'll be up and running in a jiffy!"><meta name="twitter:card" content="summary_large_image"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta property="og:image" content="https://files.readme.io/45785f4-brandmark-blue.svg"><meta name="twitter:image" content="https://files.readme.io/45785f4-brandmark-blue.svg"><link id="favicon" rel="shortcut icon" href="https://files.readme.io/5aeef98-favicon.ico" type="image/x-icon"><link rel="canonical" href="https://developer.bitpay.com/docs/getting-started"><script src="https://cdn.readme.io/public/js/cash-dom.min.js?1732290089794"></script><link data-chunk="New" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/New.f8e4e9e20d429e588f3c.css"> <link data-chunk="routes-Tutorials" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.1d38d1ab2f3572f1dd24.css"> <link data-chunk="Page" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Page.f8e4e9e20d429e588f3c.css"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.394c4b2f8910cf363781.css"> <link data-chunk="routes-Discuss" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Discuss.8f79ff8c1099c5933136.css"> <link data-chunk="List" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/List.8b6b887d01c2343868e8.css"> <link data-chunk="routes-Changelog" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="Editor" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Editor.c9adabeec62cc7e2bd7a.css"> <link data-chunk="CustomPage" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-Doc" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Doc.921b58c17b447c4e783e.css"> <link data-chunk="routes-PageNotFound" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="routes-Landing" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Landing.c5ea43d2f4b3b926ff1f.css"> <link data-chunk="routes-Reference" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Reference.087102afd3bca3215f45.css"> <link data-chunk="Header" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Header.1c46140f4fda4e981a8d.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.db8b3beb03eead84c21e.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/8263.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/main.2415ba38e8e5c2ba190e.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/ui-styles.a5d24742a3656724b61d.css"> <link data-chunk="main" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/main.766cf20fa350c2c18107.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6859.fc1496da022e612abe33.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1802.00a1e88cc0d9da2aae1b.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9772.1912e092b9c8785ff5c3.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3284.6ecd6ef27e2009d3fdc7.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7372.aa4569536a36087cf4a9.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9082.f9fa9ec2b80af1ef61bd.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/572.bab1eda8453360a8a761.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5312.ca2c08ec1b75bb03c21e.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5548.8fb1bb5d57de6c263c67.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2395.6288c030d5183baa5a89.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6522.057d8ea587133ae98687.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7112.69c3d611e7e54e411b26.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4608.3b5a227647e78e858c3f.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/8263.a563779273b90f66c0db.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1282.591f476c316bf3670bbd.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.a3bb3020bf29f8f67ef8.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3880.3892311d81c548cb073c.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7783.48ca7ef3a5c469d97e53.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Header.ad57d9fcd570c04fb712.js"> <link data-chunk="core-icons-chevron-up-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7971.db270c2970b791e38435.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6722.e485c5aa155bd0f0ccf8.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/153.e4db5a313c7d51383015.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Reference.d66a49f09580aafdabb6.js"> <link data-chunk="Footer" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Footer.eb98b86c4279989f5a59.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4002.08d1caef58d08eaccd19.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Landing.f0816876bdfbbc06801a.js"> <link data-chunk="routes-PageNotFound" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.84a460336ee9c83a7d55.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6841.587d285d41ca8bab11b1.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Doc.e3a4e0817a9a640436bc.js"> <link data-chunk="CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6922.e8247ef6931a72e55b3e.js"> <link data-chunk="CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2859.94b03b9a9585460aa921.js"> <link data-chunk="Editor" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Editor.002979730c36f9c65ad3.js"> <link data-chunk="core-icons-x-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-x-circle-svg.abc0e0ea5b7f9dff667c.js"> <link data-chunk="core-icons-suggested-edits-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-suggested-edits-svg.8d2d8ac2fd22ded9238d.js"> <link data-chunk="core-icons-arrow-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-arrow-right-svg.eadb74658f93b4e7d75f.js"> <link data-chunk="core-icons-arrow-up-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-arrow-up-right-svg.8ec73f7e322d79a2695b.js"> <link data-chunk="core-icons-more-vertical-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-more-vertical-svg.4822b3f831e11095980d.js"> <link data-chunk="core-icons-lock-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"> <link data-chunk="routes-Changelog" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Changelog.3f125a62ed05cc53aec4.js"> <link data-chunk="Post" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Post.cced33af5051de7f473f.js"> <link data-chunk="core-icons-alert-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-alert-circle-svg.4cee8264c97045599b56.js"> <link data-chunk="core-icons-webhook-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.js"> <link data-chunk="core-icons-chevron-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2637.a5df1d5e240762d7981f.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4674.13378da16ce7b5beba66.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/List.12cee315afa198c8e23e.js"> <link data-chunk="routes-Discuss" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Discuss.6a5b69949f194448cf4f.js"> <link data-chunk="core-icons-trending-up-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-trending-up-svg.0dd920b0698e57f75afa.js"> <link data-chunk="core-icons-callout-info-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-callout-info-svg.79b14e8568c9cecbc827.js"> <link data-chunk="core-icons-search-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"> <link data-chunk="core-icons-custom-pages-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7285.703d773b1bb63ae6e7ee.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.5ccfbee71da134a1eeba.js"> <link data-chunk="rmdx" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/rmdx.594ae0fac8012b876a80.js"> <link data-chunk="Page" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Page.65c6f721688901333944.js"> <link data-chunk="core-icons-eye-off-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-eye-off-svg.b2b8b241b4b324dfd9c1.js"> <link data-chunk="core-icons-star-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-star-svg.b834e1612cb2af1e174e.js"> <link data-chunk="routes-Tutorials" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.8adf2bf8562dfeff14b4.js"> <link data-chunk="core-icons-inbox-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-inbox-svg.01c2ecb759e417a98bb8.js"> <link data-chunk="core-icons-message-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-message-circle-svg.1e24c2d2eb4f9a6ede5d.js"> <link data-chunk="core-icons-key-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-key-svg.71e09670b926900508b8.js"> <link data-chunk="New" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/New.908bc26e77bebc585452.js"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/ui-styles.a5d24742a3656724b61d.css"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/main.2415ba38e8e5c2ba190e.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/8263.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.db8b3beb03eead84c21e.css"> <link data-chunk="Header" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Header.1c46140f4fda4e981a8d.css"> <link data-chunk="routes-Reference" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Reference.087102afd3bca3215f45.css"> <link data-chunk="routes-Landing" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Landing.c5ea43d2f4b3b926ff1f.css"> <link data-chunk="routes-PageNotFound" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="routes-Doc" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Doc.921b58c17b447c4e783e.css"> <link data-chunk="CustomPage" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="Editor" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Editor.c9adabeec62cc7e2bd7a.css"> <link data-chunk="routes-Changelog" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="List" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/List.8b6b887d01c2343868e8.css"> <link data-chunk="routes-Discuss" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Discuss.8f79ff8c1099c5933136.css"> <link data-chunk="routes-SuperHub-Routes" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.394c4b2f8910cf363781.css"> <link data-chunk="Page" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Page.f8e4e9e20d429e588f3c.css"> <link data-chunk="routes-Tutorials" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.1d38d1ab2f3572f1dd24.css"> <link data-chunk="New" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/New.f8e4e9e20d429e588f3c.css"><style title="rm-custom-css">:root{--project-color-primary:#1a3a8b;--project-color-inverse:#fff;--recipe-button-color:#1a3a8b;--recipe-button-color-hover:#0a1635;--recipe-button-color-active:#02040a;--recipe-button-color-focus:rgba(26, 58, 139, 0.25);--recipe-button-color-disabled:#88a4e9}[id=enterprise] .ReadMeUI[is=AlgoliaSearch]{--project-color-primary:#1a3a8b;--project-color-inverse:#fff}a{color:var(--color-link-primary,#1a3a8b)}a:hover{color:var(--color-link-primary-darken-5,#0a1635)}a.text-muted:hover{color:var(--color-link-primary,#1a3a8b)}.btn.btn-primary{background-color:#1a3a8b}.btn.btn-primary:hover{background-color:#0a1635}.theme-line #hub-landing-top h2{color:#1a3a8b}#hub-landing-top .btn:hover{color:#1a3a8b}.theme-line #hub-landing-top .btn:hover{color:#fff}.theme-solid header#hub-header #header-top{background-color:#1a3a8b}.theme-solid.header-gradient header#hub-header #header-top{background:linear-gradient(to bottom,#1a3a8b,#071c51)}.theme-solid.header-custom header#hub-header #header-top{background-image:url(undefined)}.theme-line header#hub-header #header-top{border-bottom-color:#1a3a8b}.theme-line header#hub-header #header-top .btn{background-color:#1a3a8b}header#hub-header #header-top #header-logo{width:115px;height:40px;margin-top:0;background-image:url(https://files.readme.io/de78cc6-small-bitpay-logo.png)}#hub-subheader-parent #hub-subheader .hub-subheader-breadcrumbs .dropdown-menu a:hover{background-color:#1a3a8b}#subheader-links a.active{color:#1a3a8b!important;box-shadow:inset 0 -2px 0 #1a3a8b}#subheader-links a:hover{color:#1a3a8b!important;box-shadow:inset 0 -2px 0 #1a3a8b;opacity:.7}.discussion .submit-vote.submit-vote-parent.voted a.submit-vote-button{background-color:#1a3a8b}section#hub-discuss .discussion a .discuss-body h4{color:#1a3a8b}section#hub-discuss .discussion a:hover .discuss-body h4{color:#0a1635}#hub-subheader-parent #hub-subheader.sticky-header.sticky{border-bottom-color:#1a3a8b}#hub-subheader-parent #hub-subheader.sticky-header.sticky .search-box{border-bottom-color:#1a3a8b}#hub-search-results h3 em{color:#1a3a8b}.main_background,.tag-item{background:#1a3a8b!important}.main_background:hover{background:#0a1635!important}.main_color{color:#1a3a8b!important}.border_bottom_main_color{border-bottom:2px solid #1a3a8b}.main_color_hover:hover{color:#1a3a8b!important}section#hub-discuss h1{color:#1a3a8b}#hub-reference .hub-api .api-definition .api-try-it-out.active{border-color:#1a3a8b;background-color:#1a3a8b}#hub-reference .hub-api .api-definition .api-try-it-out.active:hover{background-color:#0a1635;border-color:#0a1635}#hub-reference .hub-api .api-definition .api-try-it-out:hover{border-color:#1a3a8b;color:#1a3a8b}#hub-reference .hub-reference .logs .logs-empty .logs-login-button,#hub-reference .hub-reference .logs .logs-login .logs-login-button{background-color:var(--project-color-primary,#1a3a8b);border-color:var(--project-color-primary,#1a3a8b)}#hub-reference .hub-reference .logs .logs-empty .logs-login-button:hover,#hub-reference .hub-reference .logs .logs-login .logs-login-button:hover{background-color:#0a1635;border-color:#0a1635}#hub-reference .hub-reference .logs .logs-empty>svg>path,#hub-reference .hub-reference .logs .logs-login>svg>path{fill:#1a3a8b;fill:var(--project-color-primary,#1a3a8b)}#hub-reference .hub-reference .logs:last-child .logs-empty,#hub-reference .hub-reference .logs:last-child .logs-login{margin-bottom:35px}#hub-reference .hub-reference .hub-reference-section .hub-reference-left header .hub-reference-edit:hover{color:#1a3a8b}.main-color-accent{border-bottom:3px solid #1a3a8b;padding-bottom:8px}/*! BEGIN HUB_CUSTOM_STYLES */.table .child::before{content:'\21B3';margin-right:12px}.table .childchild::before{content:'\21B3';margin-right:12px;padding-left:24px}.table .childchildchild::before{content:'\21B3';margin-right:12px;padding-left:36px}/*! END HUB_CUSTOM_STYLES */</style><meta name="loadedProject" content="bitpay"><script> function showhide(control) { var target = `[aria-controls="${control}-collapse"] img`; var icon = document.querySelector(target); var x = document.getElementById(`${control}-collapse`); if (x.style.display === "none") { x.style.display = "block"; icon.src = "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgd2lkdGg9IjI0IiBoZWlnaHQ9IjI0Ij48dGl0bGU+RGVsZXRlPC90aXRsZT48ZyBjbGFzcz0ibmMtaWNvbi13cmFwcGVyIiBmaWxsPSIjZmZmZmZmIj48cmVjdCB4PSI2IiB5PSIxMSIgd2lkdGg9IjEyIiBoZWlnaHQ9IjIiIGZpbGw9IiNmZmZmZmYiLz48L2c+PC9zdmc+Cg=="; } else { x.style.display = "none"; icon.src = "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgd2lkdGg9IjI0IiBoZWlnaHQ9IjI0Ij48dGl0bGU+QWRkPC90aXRsZT48ZyBjbGFzcz0ibmMtaWNvbi13cmFwcGVyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIHN0cm9rZS13aWR0aD0iMiIgZmlsbD0iI2ZmZmZmZiIgc3Ryb2tlPSIjZmZmZmZmIj48bGluZSBmaWxsPSJub25lIiBzdHJva2U9IiNmZmZmZmYiIHN0cm9rZS1taXRlcmxpbWl0PSIxMCIgeDE9IjEyIiB5MT0iNyIgeDI9IjEyIiB5Mj0iMTciLz4gPGxpbmUgZmlsbD0ibm9uZSIgc3Ryb2tlPSIjZmZmZmZmIiBzdHJva2UtbWl0ZXJsaW1pdD0iMTAiIHgxPSIxNyIgeTE9IjEyIiB4Mj0iNyIgeTI9IjEyIi8+PC9nPjwvc3ZnPgo="; } } </script><script>var storedColorMode = `system` === 'system' ? window.localStorage.getItem('color-scheme') : `system` document.querySelector('[data-color-mode]').setAttribute('data-color-mode', storedColorMode)</script><script id="config" type="application/json" data-json="{"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-2024-05","fullstory":{"enabled":true,"orgId":"FSV9A"},"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.235.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}}"></script></head><body class="body-none theme-solid header-solid header-bg-size-auto header-bg-pos-tl header-overlay-triangles reference-layout-row lumosity-normal "><div id="ssr-top"></div><div id="ssr-main"><div class="App ThemeContext ThemeContext_dark " style="--color-primary:#1a3a8b;--color-primary-inverse:#fff;--color-primary-alt:#071c51;--color-primary-darken-10:#122860;--color-primary-darken-20:#0a1635;--color-primary-alpha-25:rgba(26, 58, 139, 0.25);--color-link-primary:#1a3a8b;--color-link-primary-darken-5:#163176;--color-link-primary-darken-10:#122860;--color-link-primary-darken-20:#0a1635;--color-link-primary-alpha-50:rgba(26, 58, 139, 0.5);--color-link-primary-alpha-25:rgba(26, 58, 139, 0.25);--color-link-background:rgba(26, 58, 139, 0.09);--color-link-text:#fff;--color-login-link:#018ef5;--color-login-link-text:#fff;--color-login-link-darken-10:#0171c2;--color-login-link-primary-alpha-50:rgba(1, 142, 245, 0.5)"><header class="Header3zzata9F_ZPQ rm-Header "><div class="rm-Header-top Header-topuTMpygDG4e1V"><div class="rm-Container rm-Container_flex"><div style="outline:none" tabindex="-1"><a href="#content" target="_self" class="Button Button_md rm-JumpTo Header-jumpTo3IWKQXmhSI5D Button_primary">Jump to Content</a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU"><a class="rm-Logo Header-logo1Xy41PtkzbdG" href="/" target="_self"><img alt="bitpay" class="rm-Logo-img Header-logo-img3YvV4lcGKkeb" src="https://files.readme.io/de78cc6-small-bitpay-logo.png"/></a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU Header-left_mobile1RG-X93lx6PF"><div><button aria-label="Toggle navigation menu" class="icon-menu menu3d6DYNDa3tk5" type="button"></button><div class=""><div class="Flyout95xhYIIoTKtc undefined rm-Flyout" data-testid="flyout"><div class="MobileFlyout1hHJpUd-nYkd"><a aria-current="page" class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- active" href="/docs" target="_self"><i class="icon-guides NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Guides</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/reference" target="_self"><i class="icon-references NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">API & SDK Documentation</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/changelog" target="_self"><i class="icon-changelog NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Changelog</span></a><hr class="MobileFlyout-divider10xf7R2X1MeW"/><a class="MobileFlyout-logo3Lq1eTlk1K76 Header-logo1Xy41PtkzbdG rm-Logo" href="/" target="_self"><img alt="bitpay" class="Header-logo-img3YvV4lcGKkeb rm-Logo-img" src="https://files.readme.io/de78cc6-small-bitpay-logo.png"/></a></div></div></div></div><div class="Header-left-nav2xWPWMNHOGf_"><i class="icon-guides Header-left-nav-icon10glJKFwewOv"></i>Guides</div></div><div class="rm-Header-right Header-right21PC2XTT6aMg"><span class="Header-right_desktop14ja01RUQ7HE"></span><div class="ThemeToggle-wrapper1M_iJESXCpGR Dropdown Dropdown_closed"><button aria-label="Toggle to light mode" id="ThemeToggle-button-static-id-placeholder" aria-haspopup="dialog" class="Button Button_slate_text Button_sm rm-ThemeToggle ThemeToggle2tVPbUyQbWDo Dropdown-toggle Button_primary" type="button"><svg aria-labelledby="ThemeToggle-button-static-id-placeholder" class="Icon ThemeToggle-Icon3g9ZT7pRMwCv " role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Moon (Dark Mode)</title><path d="M19 14.79C18.8427 16.4922 18.2039 18.1144 17.1582 19.4668C16.1126 20.8192 14.7035 21.8458 13.0957 22.4265C11.4879 23.0073 9.74798 23.1181 8.0795 22.7461C6.41102 22.3741 4.88299 21.5345 3.67423 20.3258C2.46546 19.117 1.62594 17.589 1.25391 15.9205C0.881876 14.252 0.992717 12.5121 1.57346 10.9043C2.1542 9.29651 3.18083 7.88737 4.53321 6.84175C5.8856 5.79614 7.5078 5.15731 9.21 5C8.21341 6.34827 7.73385 8.00945 7.85853 9.68141C7.98322 11.3534 8.70386 12.9251 9.8894 14.1106C11.0749 15.2961 12.6466 16.0168 14.3186 16.1415C15.9906 16.2662 17.6517 15.7866 19 14.79Z"></path><path class="ThemeToggle-Icon-star3wweJby1gM4w" d="M18.3707 1C18.3707 3.22825 16.2282 5.37069 14 5.37069C16.2282 5.37069 18.3707 7.51313 18.3707 9.74138C18.3707 7.51313 20.5132 5.37069 22.7414 5.37069C20.5132 5.37069 18.3707 3.22825 18.3707 1Z"></path></svg><svg aria-labelledby="ThemeToggle-button-static-id-placeholder" class="Icon ThemeToggle-Icon3g9ZT7pRMwCv ThemeToggle-Icon_active18I2-19CkbgD" role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Sun (Light Mode)</title><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M12 1V3"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M18.36 5.64L19.78 4.22"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M21 12H23"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M18.36 18.36L19.78 19.78"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M12 21V23"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M4.22 19.78L5.64 18.36"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M1 12H3"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M4.22 4.22L5.64 5.64"></path><path d="M12 17C14.7614 17 17 14.7614 17 12C17 9.23858 14.7614 7 12 7C9.23858 7 7 9.23858 7 12C7 14.7614 9.23858 17 12 17Z"></path></svg></button></div></div></div></div><div class="Header-bottom2eLKOFXMEmh5 rm-Header-bottom rm-Header-bottom_withOwlbot Header-bottom_withOwlbot3wuKp8NLXCqs"><div class="rm-Container rm-Container_flex"><nav class="Header-leftADQdGVqx1wqU"><a aria-current="page" class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile active" href="/docs" target="_self"><i class="icon-guides"></i><span>Guides</span></a><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " href="/reference" target="_self"><i class="icon-references"></i><span>API & SDK Documentation</span></a><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " href="/changelog" target="_self"><i class="icon-changelog"></i><span>Changelog</span></a></nav><button align="center" justify="between" style="--flex-gap:var(--xs)" class="Button Button_sm Flex Flex_row MobileSubnav1DsTfasXloM2 Button_contrast Button_contrast_outline" type="button"><span class="Button-label">Getting Started with BitPay</span><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="chevron-up-down" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="m6 16 6 6 6-6M18 8l-6-6-6 6" class="icon-stroke-width"></path></svg></span></button><div class="rm-Header-search Header-searchtb6Foi0-D9Vx Header-search_owlbot2iEpu0FSLYUx rm-Header-search_feather Header-search_featherYsmQBn55F3d9"></div></div></div><div class="hub-search-results--reactApp " id="hub-search-results"><div class="hub-container"><div class="modal-backdrop show-modal rm-SearchModal" role="button" tabindex="0"></div></div></div></header><main class="rm-Guides"><div class="rm-Container rm-Container_flex"><nav aria-label="Page navigation" class="rm-Sidebar hub-sidebar reference-redesign Nav3C5f8FcjkaHj rm-Sidebar_guides" id="hub-sidebar"><div class="Sidebar1t2G1ZJq-vU1 rm-Sidebar hub-sidebar-content"><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Documentation</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a aria-current="page" class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link active" target="_self" href="/docs/getting-started"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Getting Started with BitPay</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/plugins"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for eCommerce Plugins" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">eCommerce Plugins</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/magento2"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Magento 2</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/shopify-plugin"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Shopify</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/whmcs"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">WHMCS</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/wix"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Wix</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/woocommerce"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">WooCommerce</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/bigcommerce"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">BigCommerce</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/libraries"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Libraries</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/signed-request-flow"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Signing API Calls</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/settlement"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Banking & Settlements" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Banking & Settlements</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/exporting-ledger-data"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Exporting Ledger Data</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/user-privileges"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for BitPay Merchant Dashboard" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">BitPay Merchant Dashboard</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/user-privileges"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">User Privileges</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/ledgers-1"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Ledgers</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/two-factor-authentication"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Two Factor Authentication</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/email-billing"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Email Billing</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/credentials"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Credentials</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/support-faqs"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Support & FAQs</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/wallets-by-currency"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Wallets by Currency</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/currencies-by-wallet"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Currencies by Wallet</span></span></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Guides</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/bitpay-integration-guide"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for BitPay Integration Guide" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">BitPay Integration Guide</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/integration-1"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Integration</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/api-integrations-additional-information"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">API Integrations - Additional Information</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/compliance"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Compliance</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/marketing"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Marketing</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/testing"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Setup and Testing</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/checkout-integration"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Checkout Integration" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Checkout Integration</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/checkout-page"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Checkout Page</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/create-invoice"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Creating Invoices</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/display-invoice"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Displaying Invoices</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/invoice-webhooks"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Invoice Webhooks</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/invoice-states"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Invoice States</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/in-person-payments"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for In Person Payments" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">In Person Payments</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/initiating-payment"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Setup & Initiate Payment</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/customer-payment"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Customer Payment</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/payment-status-updated"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Payment Status</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/in-store-troubleshooting"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Troubleshooting</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/docs/payouts-sending-crypto"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Payouts (Sending Crypto)" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Payouts (Sending Crypto)</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/send-invites"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Invite Payout Recipients</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/accepting-invitations"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Accepting Invitations</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/docs/initiating-payouts-post-invitation"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Send Payouts</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/passing-the-bitpay-fee-on-to-customers"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Passing BitPay's Processing Fees to Customers</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/refunding-payments"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Refunding Payments</span></span></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Use Cases</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/ecommerce"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Ecommerce</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/donations"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Donations</span></span></a></li></ul></section><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Wallet Integrations</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/docs/payment-protocol"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">JSON Payment Protocol</span></span></a></li></ul></section></div></nav><article class="rm-Article " id="content"><header id="content-head"><div class="row clearfix"><div class="col-xs-9"><h1>Getting Started with BitPay</h1><div class="excerpt"><div class="rm-Markdown markdown-body" data-testid="RDMD"><p>This page will help you get started with BitPay. You'll be up and running in a jiffy!</p></div></div></div><div class="col-xs-3"><a class="suggestEdits" rel="nofollow" href="/edit/getting-started"><i aria-hidden="true" class="icon icon-edit"></i> Suggest Edits</a></div></div></header><div class="grid-container-fluid" id="content-container"><section class="content-body grid-75"><div dehydrated="<p>BitPay’s integrations make accepting blockchain payments fast and reliable. To get started, <a href="https://bitpay.com/dashboard/signup" target="" title="">sign up for a BitPay account</a>.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="accepting-a-blockchain-payment"></div><div class="heading-text"><div id="section-accepting-a-blockchain-payment" class="heading-anchor_backwardsCompatibility"></div>Accepting a Blockchain Payment</div><a aria-label="Skip link to Accepting a Blockchain Payment" class="heading-anchor-icon fa fa-anchor" href="#accepting-a-blockchain-payment"></a></h2> <p>With blockchain payments, there&#x27;s no sensitive customer information to collect and store, and there are no cards to charge. Customers simply send cryptocurrencies (like Bitcoin, Ether, or Ripple) from their computer or mobile device directly to a payment address.</p> <p>Once received, BitPay converts the cryptocurrencies to your preferred currency and adds the full amount of the payment to your next BitPay account <a href="/docs/settlement" target="" title="">settlement</a>. Funds are then deposited to your bank account or cryptocurrency wallet.</p> <p>You can accept blockchain payments in a variety of ways. Choose a method below to get started.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="online-payments"></div><div class="heading-text"><div id="section-online-payments" class="heading-anchor_backwardsCompatibility"></div>Online Payments</div><a aria-label="Skip link to Online Payments" class="heading-anchor-icon fa fa-anchor" href="#online-payments"></a></h2> <p>Blockchain payments make the online payment experience simple and convenient for customers on any device – customers can pay with just two taps, no sensitive personal information needed.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="e-commerce-plugins"></div><div class="heading-text"><div id="section-e-commerce-plugins" class="heading-anchor_backwardsCompatibility"></div>E-Commerce Plugins</div><a aria-label="Skip link to E-Commerce Plugins" class="heading-anchor-icon fa fa-anchor" href="#e-commerce-plugins"></a></h3> <p>Accepting cryptocurrency payments with our partner platforms can be as easy as flipping a switch. View our <a href="/docs/plugins" target="" title="">full list of integrations</a> for details.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="code-libraries"></div><div class="heading-text"><div id="section-code-libraries" class="heading-anchor_backwardsCompatibility"></div>Code Libraries</div><a aria-label="Skip link to Code Libraries" class="heading-anchor-icon fa fa-anchor" href="#code-libraries"></a></h3> <p>BitPay <a href="/docs/libraries" target="" title="">code libraries</a> allow developers to focus on payment flow &amp; e-commerce integration rather than on the specific details of client-server interaction using the API.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="direct-api-implementation"></div><div class="heading-text"><div id="section-direct-api-implementation" class="heading-anchor_backwardsCompatibility"></div>Direct API Implementation</div><a aria-label="Skip link to Direct API Implementation" class="heading-anchor-icon fa fa-anchor" href="#direct-api-implementation"></a></h3> <p>Build yourself the integration using BitPay&#x27;s <a href="https://developer.bitpay.com/reference/concepts" target="" title="">REST API</a> to add blockchain payments to your online checkout.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="website-payment-buttons"></div><div class="heading-text"><div id="section-website-payment-buttons" class="heading-anchor_backwardsCompatibility"></div>Website Payment Buttons</div><a aria-label="Skip link to Website Payment Buttons" class="heading-anchor-icon fa fa-anchor" href="#website-payment-buttons"></a></h3> <p>If you are only selling a few items and do not have a checkout cart, simply generate a <a href="/docs/ecommerce#buttons" target="" title="">payment button</a> for your website directly through your merchant dashboard. No code-wrangling required – just copy and embed the generated html code into your page.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="in-store-payments"></div><div class="heading-text"><div id="section-in-store-payments" class="heading-anchor_backwardsCompatibility"></div>In-Store Payments</div><a aria-label="Skip link to In-Store Payments" class="heading-anchor-icon fa fa-anchor" href="#in-store-payments"></a></h2> <p>Merchants can use BitPay&#x27;s retail payment tools alongside traditional point of sale systems to create a faster, hassle-free checkout experience for customers and staff.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="bitpay-checkout-app"></div><div class="heading-text"><div id="section-bit-pay-checkout-app" class="heading-anchor_backwardsCompatibility"></div>BitPay Checkout App</div><a aria-label="Skip link to BitPay Checkout App" class="heading-anchor-icon fa fa-anchor" href="#bitpay-checkout-app"></a></h3> <p>Merchants can use BitPay Checkout app to accept cryptocurrency payments on <a href="https://itunes.apple.com/us/app/bitcoin-checkout/id929652207?mt=8" target="" title="">iOS</a> or <a href="https://play.google.com/store/apps/details?id=com.bitpay.checkout&amp;hl=en" target="" title="">Android</a> smartphones or tablets.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="donations"></div><div class="heading-text"><div id="section-donations" class="heading-anchor_backwardsCompatibility"></div>Donations</div><a aria-label="Skip link to Donations" class="heading-anchor-icon fa fa-anchor" href="#donations"></a></h2> <p>Nonprofits can get a running start with blockchain contributions with our donation buttons and hosted donation pages.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="donation-buttons"></div><div class="heading-text"><div id="section-donation-buttons" class="heading-anchor_backwardsCompatibility"></div>Donation Buttons</div><a aria-label="Skip link to Donation Buttons" class="heading-anchor-icon fa fa-anchor" href="#donation-buttons"></a></h3> <p>BitPay&#x27;s <a href="/docs/donations#buttons" target="" title="">donation buttons</a> make it simple to accept contributions on your organization&#x27;s website.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="hosted-donation-pages"></div><div class="heading-text"><div id="section-hosted-donation-pages" class="heading-anchor_backwardsCompatibility"></div>Hosted Donation Pages</div><a aria-label="Skip link to Hosted Donation Pages" class="heading-anchor-icon fa fa-anchor" href="#hosted-donation-pages"></a></h3> <p>BitPay can create and host a customizable <a href="/docs/donations#pages" target="" title="">donation webpage</a> for your organization.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="custom-web-page"></div><div class="heading-text"><div id="section-custom-web-page" class="heading-anchor_backwardsCompatibility"></div>Custom Web Page</div><a aria-label="Skip link to Custom Web Page" class="heading-anchor-icon fa fa-anchor" href="#custom-web-page"></a></h3> <p>Use our <a href="https://github.com/bitpay/bitpay-donation-sample-code" target="" title="">sample code</a> as a starting point to quickly set up a web page that is customized to your needs. </p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="billing"></div><div class="heading-text"><div id="section-billing" class="heading-anchor_backwardsCompatibility"></div>Billing</div><a aria-label="Skip link to Billing" class="heading-anchor-icon fa fa-anchor" href="#billing"></a></h2> <p>Our blockchain billing tools allow merchants to invoice and receive payment for services and goods in no time flat.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="email-billing"></div><div class="heading-text"><div id="section-email-billing" class="heading-anchor_backwardsCompatibility"></div>Email Billing</div><a aria-label="Skip link to Email Billing" class="heading-anchor-icon fa fa-anchor" href="#email-billing"></a></h3> <p>You can use our <a href="https://bitpay.com/dashboard/payment-tools/bills" target="" title="">dashboard billing tool</a> to create and email invoices to your clients in a snap. Bills can be scheduled for one-time or recurring payments.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="cross-border-billing"></div><div class="heading-text"><div id="section-cross-border-billing" class="heading-anchor_backwardsCompatibility"></div>Cross-Border Billing</div><a aria-label="Skip link to Cross-Border Billing" class="heading-anchor-icon fa fa-anchor" href="#cross-border-billing"></a></h3> <p>Skip costly, complicated cross-border wire transfers. Receive international accounts receivable payments and get 100% accuracy, zero fraud risk, and fast bank settlement.</p>" style="margin-left:31px" class="rm-Markdown markdown-body rm-Markdown markdown-body ng-non-bindable" data-testid="RDMD"><p>BitPay’s integrations make accepting blockchain payments fast and reliable. To get started, <a target="_self" href="https://bitpay.com/dashboard/signup">sign up for a BitPay account</a>.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="accepting-a-blockchain-payment"></div><div class="heading-text"><div id="section-accepting-a-blockchain-payment" class="heading-anchor_backwardsCompatibility"></div>Accepting a Blockchain Payment</div><a aria-label="Skip link to Accepting a Blockchain Payment" class="heading-anchor-icon fa fa-anchor" href="#accepting-a-blockchain-payment"></a></h2> <p>With blockchain payments, there's no sensitive customer information to collect and store, and there are no cards to charge. Customers simply send cryptocurrencies (like Bitcoin, Ether, or Ripple) from their computer or mobile device directly to a payment address.</p> <p>Once received, BitPay converts the cryptocurrencies to your preferred currency and adds the full amount of the payment to your next BitPay account <a target="_self" href="/docs/settlement">settlement</a>. Funds are then deposited to your bank account or cryptocurrency wallet.</p> <p>You can accept blockchain payments in a variety of ways. Choose a method below to get started.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="online-payments"></div><div class="heading-text"><div id="section-online-payments" class="heading-anchor_backwardsCompatibility"></div>Online Payments</div><a aria-label="Skip link to Online Payments" class="heading-anchor-icon fa fa-anchor" href="#online-payments"></a></h2> <p>Blockchain payments make the online payment experience simple and convenient for customers on any device – customers can pay with just two taps, no sensitive personal information needed.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="e-commerce-plugins"></div><div class="heading-text"><div id="section-e-commerce-plugins" class="heading-anchor_backwardsCompatibility"></div>E-Commerce Plugins</div><a aria-label="Skip link to E-Commerce Plugins" class="heading-anchor-icon fa fa-anchor" href="#e-commerce-plugins"></a></h3> <p>Accepting cryptocurrency payments with our partner platforms can be as easy as flipping a switch. View our <a target="_self" href="/docs/plugins">full list of integrations</a> for details.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="code-libraries"></div><div class="heading-text"><div id="section-code-libraries" class="heading-anchor_backwardsCompatibility"></div>Code Libraries</div><a aria-label="Skip link to Code Libraries" class="heading-anchor-icon fa fa-anchor" href="#code-libraries"></a></h3> <p>BitPay <a target="_self" href="/docs/libraries">code libraries</a> allow developers to focus on payment flow & e-commerce integration rather than on the specific details of client-server interaction using the API.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="direct-api-implementation"></div><div class="heading-text"><div id="section-direct-api-implementation" class="heading-anchor_backwardsCompatibility"></div>Direct API Implementation</div><a aria-label="Skip link to Direct API Implementation" class="heading-anchor-icon fa fa-anchor" href="#direct-api-implementation"></a></h3> <p>Build yourself the integration using BitPay's <a target="_self" href="/reference/concepts">REST API</a> to add blockchain payments to your online checkout.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="website-payment-buttons"></div><div class="heading-text"><div id="section-website-payment-buttons" class="heading-anchor_backwardsCompatibility"></div>Website Payment Buttons</div><a aria-label="Skip link to Website Payment Buttons" class="heading-anchor-icon fa fa-anchor" href="#website-payment-buttons"></a></h3> <p>If you are only selling a few items and do not have a checkout cart, simply generate a <a target="_self" href="/docs/ecommerce#buttons">payment button</a> for your website directly through your merchant dashboard. No code-wrangling required – just copy and embed the generated html code into your page.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="in-store-payments"></div><div class="heading-text"><div id="section-in-store-payments" class="heading-anchor_backwardsCompatibility"></div>In-Store Payments</div><a aria-label="Skip link to In-Store Payments" class="heading-anchor-icon fa fa-anchor" href="#in-store-payments"></a></h2> <p>Merchants can use BitPay's retail payment tools alongside traditional point of sale systems to create a faster, hassle-free checkout experience for customers and staff.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="bitpay-checkout-app"></div><div class="heading-text"><div id="section-bit-pay-checkout-app" class="heading-anchor_backwardsCompatibility"></div>BitPay Checkout App</div><a aria-label="Skip link to BitPay Checkout App" class="heading-anchor-icon fa fa-anchor" href="#bitpay-checkout-app"></a></h3> <p>Merchants can use BitPay Checkout app to accept cryptocurrency payments on <a target="_self" href="https://itunes.apple.com/us/app/bitcoin-checkout/id929652207?mt=8">iOS</a> or <a target="_self" href="https://play.google.com/store/apps/details?id=com.bitpay.checkout&hl=en">Android</a> smartphones or tablets.</p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="donations"></div><div class="heading-text"><div id="section-donations" class="heading-anchor_backwardsCompatibility"></div>Donations</div><a aria-label="Skip link to Donations" class="heading-anchor-icon fa fa-anchor" href="#donations"></a></h2> <p>Nonprofits can get a running start with blockchain contributions with our donation buttons and hosted donation pages.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="donation-buttons"></div><div class="heading-text"><div id="section-donation-buttons" class="heading-anchor_backwardsCompatibility"></div>Donation Buttons</div><a aria-label="Skip link to Donation Buttons" class="heading-anchor-icon fa fa-anchor" href="#donation-buttons"></a></h3> <p>BitPay's <a target="_self" href="/docs/donations#buttons">donation buttons</a> make it simple to accept contributions on your organization's website.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="hosted-donation-pages"></div><div class="heading-text"><div id="section-hosted-donation-pages" class="heading-anchor_backwardsCompatibility"></div>Hosted Donation Pages</div><a aria-label="Skip link to Hosted Donation Pages" class="heading-anchor-icon fa fa-anchor" href="#hosted-donation-pages"></a></h3> <p>BitPay can create and host a customizable <a target="_self" href="/docs/donations#pages">donation webpage</a> for your organization.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="custom-web-page"></div><div class="heading-text"><div id="section-custom-web-page" class="heading-anchor_backwardsCompatibility"></div>Custom Web Page</div><a aria-label="Skip link to Custom Web Page" class="heading-anchor-icon fa fa-anchor" href="#custom-web-page"></a></h3> <p>Use our <a target="_self" href="https://github.com/bitpay/bitpay-donation-sample-code">sample code</a> as a starting point to quickly set up a web page that is customized to your needs. </p> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="billing"></div><div class="heading-text"><div id="section-billing" class="heading-anchor_backwardsCompatibility"></div>Billing</div><a aria-label="Skip link to Billing" class="heading-anchor-icon fa fa-anchor" href="#billing"></a></h2> <p>Our blockchain billing tools allow merchants to invoice and receive payment for services and goods in no time flat.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="email-billing"></div><div class="heading-text"><div id="section-email-billing" class="heading-anchor_backwardsCompatibility"></div>Email Billing</div><a aria-label="Skip link to Email Billing" class="heading-anchor-icon fa fa-anchor" href="#email-billing"></a></h3> <p>You can use our <a target="_self" href="https://bitpay.com/dashboard/payment-tools/bills">dashboard billing tool</a> to create and email invoices to your clients in a snap. Bills can be scheduled for one-time or recurring payments.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="cross-border-billing"></div><div class="heading-text"><div id="section-cross-border-billing" class="heading-anchor_backwardsCompatibility"></div>Cross-Border Billing</div><a aria-label="Skip link to Cross-Border Billing" class="heading-anchor-icon fa fa-anchor" href="#cross-border-billing"></a></h3> <p>Skip costly, complicated cross-border wire transfers. Receive international accounts receivable payments and get 100% accuracy, zero fraud risk, and fast bank settlement.</p></div><div class="UpdatedAt"><p class="DateLine "><i class="icon icon-watch"></i>Updated 27 days ago </p></div><hr class="NextStepsDivider"/><nav aria-label="Pagination Controls" class="PaginationControlsjDYuqu8pBMUy rm-Pagination"></nav></section><section class="content-toc grid-25"><nav><ul class="toc-list"><li><a class="tocHeader" href="#"><i class="icon icon-text-align-left"></i>Table of Contents</a></li><li class="toc-children"><ul> <li> <a href="#accepting-a-blockchain-payment">Accepting a Blockchain Payment</a> </li> <li> <a href="#online-payments">Online Payments</a> <ul> <li><a href="#e-commerce-plugins">E-Commerce Plugins</a></li> <li><a href="#code-libraries">Code Libraries</a></li> <li><a href="#direct-api-implementation">Direct API Implementation</a></li> <li><a href="#website-payment-buttons">Website Payment Buttons</a></li> </ul> </li> <li> <a href="#in-store-payments">In-Store Payments</a> <ul> <li><a href="#bitpay-checkout-app">BitPay Checkout App</a></li> </ul> </li> <li> <a href="#donations">Donations</a> <ul> <li><a href="#donation-buttons">Donation Buttons</a></li> <li><a href="#hosted-donation-pages">Hosted Donation Pages</a></li> <li><a href="#custom-web-page">Custom Web Page</a></li> </ul> </li> <li> <a href="#billing">Billing</a> <ul> <li><a href="#email-billing">Email Billing</a></li> <li><a href="#cross-border-billing">Cross-Border Billing</a></li> </ul> </li> </ul></li></ul></nav></section></div><div class="ModalWrapper" id="tutorialmodal-root"></div></article></div></main><footer aria-label="Status banner" class="AppFooter rm-Banners"></footer><div class="ModalWrapper" id="ChatGPT-modal"></div></div></div><div class="ng-non-bindable"><script id="ssr-props" data-initial-props="{"sidebars":{"docs":[{"_id":"6356ce887031fa001e26e991","title":"Documentation","slug":"documentation","order":0,"reference":false,"version":"6356ce887031fa001e26e98e","project":"6356ce887031fa001e26e989","createdAt":"2022-10-24T17:42:32.716Z","__v":0,"pages":[{"_id":"6356ce887031fa001e26e994","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"examples":{"codes":[]}},"title":"Getting Started with BitPay","icon":"","type":"basic","slug":"getting-started","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"6356ce887031fa001e26e991","createdAt":"2022-10-24T17:42:32.762Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"63618c17dce347003babbbff","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"eCommerce Plugins","icon":"","type":"basic","slug":"plugins","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-01T21:13:59.364Z","category":"6356ce887031fa001e26e991","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"6364046e875350111bef19ad","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Magento 2","icon":"","type":"basic","slug":"magento2","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"magento-2","createdAt":"2022-11-03T18:11:58.035Z","parentDoc":"63618c17dce347003babbbff","category":"6356ce887031fa001e26e991","isBodyEmpty":false,"children":[]},{"_id":"6364048bab2a3800293a7925","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Shopify","icon":"","type":"basic","slug":"shopify-plugin","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"shopify","createdAt":"2022-11-03T18:12:27.395Z","parentDoc":"63618c17dce347003babbbff","category":"6356ce887031fa001e26e991","isBodyEmpty":false,"children":[]},{"_id":"63e13e10f70143007509d75a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"WHMCS","icon":"","type":"basic","slug":"whmcs","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63618c17dce347003babbbff","category":"6356ce887031fa001e26e991","createdAt":"2023-02-06T17:51:12.425Z","isBodyEmpty":false,"children":[]},{"_id":"63e13b7f9e47ba00134ce543","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Wix","icon":"","type":"basic","slug":"wix","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63618c17dce347003babbbff","category":"6356ce887031fa001e26e991","createdAt":"2023-02-06T17:40:15.716Z","isBodyEmpty":false,"children":[]},{"_id":"6364047f9ce9a0009e067c0d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"WooCommerce","icon":"","type":"basic","slug":"woocommerce","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-03T18:12:15.259Z","parentDoc":"63618c17dce347003babbbff","category":"6356ce887031fa001e26e991","isBodyEmpty":false,"children":[]},{"_id":"641cbe861f18a4000ad8b19f","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"BigCommerce","icon":"","type":"basic","slug":"bigcommerce","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63618c17dce347003babbbff","category":"6356ce887031fa001e26e991","createdAt":"2023-03-23T21:03:02.107Z","isBodyEmpty":false,"children":[]}]},{"_id":"63618d052f6426008c59083c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Libraries","icon":"","type":"basic","slug":"libraries","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-01T21:17:57.801Z","category":"6356ce887031fa001e26e991","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"63bb494d062692002841318c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Signing API Calls","icon":"","type":"basic","slug":"signed-request-flow","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"6356ce887031fa001e26e991","createdAt":"2023-01-08T22:53:01.091Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"636189e0d577ec0030e12372","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Banking & Settlements","icon":"","type":"basic","slug":"settlement","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"banking-settlements","createdAt":"2022-11-01T21:04:32.390Z","category":"6356ce887031fa001e26e991","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"646b7b6891740c110588750d","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Exporting Ledger Data","icon":"","type":"basic","slug":"exporting-ledger-data","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"636189e0d577ec0030e12372","category":"6356ce887031fa001e26e991","createdAt":"2023-05-22T14:25:44.275Z","isBodyEmpty":false,"children":[]}]},{"_id":"6478ae5fc000f816be89211a","api":{"method":"get","url":"","auth":"required","params":[]},"title":"BitPay Merchant Dashboard","icon":"","type":"basic","slug":"bitpay-merchant-dashboard","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"6356ce887031fa001e26e991","createdAt":"2023-06-01T14:42:39.316Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"6478af9a22a1c014a3d98a7c","api":{"method":"get","url":"","auth":"required","params":[]},"title":"User Privileges","icon":"","type":"basic","slug":"user-privileges","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6478ae5fc000f816be89211a","category":"6356ce887031fa001e26e991","createdAt":"2023-06-01T14:47:54.186Z","isBodyEmpty":false,"children":[]},{"_id":"64a6d3b6cc9cc4003b13f31b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Ledgers","icon":"","type":"basic","slug":"ledgers-1","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6478ae5fc000f816be89211a","category":"6356ce887031fa001e26e991","createdAt":"2023-07-06T14:46:14.710Z","isBodyEmpty":false,"children":[]},{"_id":"64bea455f2dc840063fbe09c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Two Factor Authentication","icon":"","type":"basic","slug":"two-factor-authentication","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6478ae5fc000f816be89211a","category":"6356ce887031fa001e26e991","createdAt":"2023-07-24T16:18:29.406Z","isBodyEmpty":false,"children":[]},{"_id":"64ee17669ec8530070bba898","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Email Billing","icon":"","type":"basic","slug":"email-billing","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6478ae5fc000f816be89211a","category":"6356ce887031fa001e26e991","createdAt":"2023-08-29T16:05:58.797Z","isBodyEmpty":false,"children":[]},{"_id":"64ee1a2fb711a2000b27d655","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Credentials","icon":"","type":"basic","slug":"credentials","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6478ae5fc000f816be89211a","category":"6356ce887031fa001e26e991","createdAt":"2023-08-29T16:17:51.477Z","isBodyEmpty":false,"children":[]}]},{"_id":"64ee011fcc0002004ebda85d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Support & FAQs","icon":"","type":"basic","slug":"support-faqs","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"6356ce887031fa001e26e991","createdAt":"2023-08-29T14:30:55.410Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"64b6c755acecc00f55d31714","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Wallets by Currency","icon":"","type":"basic","slug":"wallets-by-currency","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"wallets-and-currencies","parentDoc":null,"category":"6356ce887031fa001e26e991","createdAt":"2023-07-18T17:09:41.832Z","isBodyEmpty":false,"children":[]},{"_id":"65526b393626d30060d69a2b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Currencies by Wallet","icon":"","type":"basic","slug":"currencies-by-wallet","order":8,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"wallets-copy","parentDoc":null,"category":"6356ce887031fa001e26e991","createdAt":"2023-11-13T18:30:17.713Z","isBodyEmpty":false,"children":[]}]},{"_id":"63618882de4302003d7b1e0d","title":"Guides","slug":"development","order":12,"reference":false,"project":"6356ce887031fa001e26e989","version":"6356ce887031fa001e26e98e","createdAt":"2022-11-01T20:58:42.179Z","__v":0,"pages":[{"_id":"63e16d3c4975a7006c896fb7","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"BitPay Integration Guide","icon":"","type":"basic","slug":"bitpay-integration-guide","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"63618882de4302003d7b1e0d","createdAt":"2023-02-06T21:12:28.913Z","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"641a02f7858330005f15373e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Integration","icon":"","type":"basic","slug":"integration-1","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63e16d3c4975a7006c896fb7","category":"63618882de4302003d7b1e0d","createdAt":"2023-03-21T19:18:15.082Z","isBodyEmpty":false,"children":[]},{"_id":"63c70fc2f28d7506e6619a73","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"API Integrations - Additional Information","icon":"","type":"basic","slug":"api-integrations-additional-information","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63e16d3c4975a7006c896fb7","category":"63618882de4302003d7b1e0d","createdAt":"2023-01-17T21:14:42.236Z","isBodyEmpty":false,"children":[]},{"_id":"63c70d9a6cc6fd0847660fdf","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Compliance","icon":"","type":"basic","slug":"compliance","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63e16d3c4975a7006c896fb7","category":"63618882de4302003d7b1e0d","createdAt":"2023-01-17T21:05:30.423Z","isBodyEmpty":false,"children":[]},{"_id":"63c70dfb0e2edd02ec8dd3b5","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Marketing","icon":"","type":"basic","slug":"marketing","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63e16d3c4975a7006c896fb7","category":"63618882de4302003d7b1e0d","createdAt":"2023-01-17T21:07:07.779Z","isBodyEmpty":false,"children":[]}]},{"_id":"63618c080b6cbb000f4e05b8","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Setup and Testing","icon":"","type":"basic","slug":"testing","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-01T21:13:44.743Z","category":"63618882de4302003d7b1e0d","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"63bd919adf5986003af48be8","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Checkout Integration","icon":"","type":"basic","slug":"checkout-integration","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"payment-flow-chart","category":"63618882de4302003d7b1e0d","createdAt":"2023-01-10T16:26:02.642Z","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"63618d1704ec8b001772977f","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Checkout Page","icon":"","type":"basic","slug":"checkout-page","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-01T21:18:15.470Z","category":"63618882de4302003d7b1e0d","parentDoc":"63bd919adf5986003af48be8","isBodyEmpty":false,"children":[]},{"_id":"63618d10971254008336d5c7","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Creating Invoices","icon":"","type":"basic","slug":"create-invoice","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"creating-invoices","createdAt":"2022-11-01T21:18:08.727Z","category":"63618882de4302003d7b1e0d","parentDoc":"63bd919adf5986003af48be8","isBodyEmpty":false,"children":[]},{"_id":"63618d22ae0fde0017973516","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Displaying Invoices","icon":"","type":"basic","slug":"display-invoice","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"displaying-invoices","createdAt":"2022-11-01T21:18:26.517Z","category":"63618882de4302003d7b1e0d","parentDoc":"63bd919adf5986003af48be8","isBodyEmpty":false,"children":[]},{"_id":"63618d2b8858ea009ad1d807","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Invoice Webhooks","icon":"","type":"basic","slug":"invoice-webhooks","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-01T21:18:35.670Z","category":"63618882de4302003d7b1e0d","parentDoc":"63bd919adf5986003af48be8","isBodyEmpty":false,"children":[]},{"_id":"63618d379ff81f0083f246f5","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Invoice States","icon":"","type":"basic","slug":"invoice-states","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-01T21:18:47.736Z","category":"63618882de4302003d7b1e0d","parentDoc":"63bd919adf5986003af48be8","isBodyEmpty":false,"children":[]}]},{"_id":"6411edeb63f19400612689e1","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"In Person Payments","icon":"","type":"basic","slug":"in-person-payments","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"testing-best-practices","category":"63618882de4302003d7b1e0d","createdAt":"2023-03-15T16:10:19.667Z","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"641334364d9a8b00113aeedc","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Setup & Initiate Payment","icon":"","type":"basic","slug":"initiating-payment","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"creating-payments","parentDoc":"6411edeb63f19400612689e1","category":"63618882de4302003d7b1e0d","createdAt":"2023-03-16T15:22:30.016Z","isBodyEmpty":false,"children":[]},{"_id":"641338a6daa2190f9be0ec40","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Customer Payment","icon":"","type":"basic","slug":"customer-payment","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6411edeb63f19400612689e1","category":"63618882de4302003d7b1e0d","createdAt":"2023-03-16T15:41:26.771Z","isBodyEmpty":false,"children":[]},{"_id":"641b3cab53e6f70035c68db9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Payment Status","icon":"","type":"basic","slug":"payment-status-updated","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6411edeb63f19400612689e1","category":"63618882de4302003d7b1e0d","createdAt":"2023-03-22T17:36:43.998Z","isBodyEmpty":false,"children":[]},{"_id":"6411e2d05669f0005d34b7a7","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Troubleshooting","icon":"","type":"basic","slug":"in-store-troubleshooting","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"63618882de4302003d7b1e0d","createdAt":"2023-03-15T15:22:56.324Z","parentDoc":"6411edeb63f19400612689e1","isBodyEmpty":false,"children":[]}]},{"_id":"6411df87938be3005e9bcf6c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Payouts (Sending Crypto)","icon":"","type":"basic","slug":"payouts-sending-crypto","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"63618882de4302003d7b1e0d","createdAt":"2023-03-15T15:08:55.024Z","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"641cb03b9db9dc0065f8bfaa","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Invite Payout Recipients","icon":"","type":"basic","slug":"send-invites","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6411df87938be3005e9bcf6c","category":"63618882de4302003d7b1e0d","createdAt":"2023-03-23T20:02:03.695Z","isBodyEmpty":false,"children":[]},{"_id":"641cb05b4d2a080072f9bf4e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Accepting Invitations","icon":"","type":"basic","slug":"accepting-invitations","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6411df87938be3005e9bcf6c","category":"63618882de4302003d7b1e0d","createdAt":"2023-03-23T20:02:35.157Z","isBodyEmpty":false,"children":[]},{"_id":"641cb0a1435042000a3afef9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Send Payouts","icon":"","type":"basic","slug":"initiating-payouts-post-invitation","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6411df87938be3005e9bcf6c","category":"63618882de4302003d7b1e0d","createdAt":"2023-03-23T20:03:45.310Z","isBodyEmpty":false,"children":[]}]},{"_id":"643ff79b7ae3c912e21b0ef8","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Passing BitPay's Processing Fees to Customers","icon":"","type":"basic","slug":"passing-the-bitpay-fee-on-to-customers","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"63618882de4302003d7b1e0d","createdAt":"2023-04-19T14:15:55.507Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"645168b819fbfc0025a7177d","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Refunding Payments","icon":"","type":"basic","slug":"refunding-payments","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"63618882de4302003d7b1e0d","createdAt":"2023-05-02T19:47:04.002Z","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"63618887a0cd0d0038b36ec9","title":"Use Cases","slug":"use-cases","order":13,"reference":false,"project":"6356ce887031fa001e26e989","version":"6356ce887031fa001e26e98e","createdAt":"2022-11-01T20:58:47.171Z","__v":0,"pages":[{"_id":"63618d46a765ff00476ce621","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Ecommerce","icon":"","type":"basic","slug":"ecommerce","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-01T21:19:02.318Z","category":"63618887a0cd0d0038b36ec9","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"63618d4ff81a440090a6a952","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Donations","icon":"","type":"basic","slug":"donations","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-01T21:19:11.583Z","category":"63618887a0cd0d0038b36ec9","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"6361888f7225b900a45e1c3c","title":"Wallet Integrations","slug":"wallet-integrations","order":14,"reference":false,"project":"6356ce887031fa001e26e989","version":"6356ce887031fa001e26e98e","createdAt":"2022-11-01T20:58:55.164Z","__v":0,"pages":[{"_id":"63618d65149ec10010f79d59","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"JSON Payment Protocol","icon":"","type":"basic","slug":"payment-protocol","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"json-payment-protocol","createdAt":"2022-11-01T21:19:33.586Z","category":"6361888f7225b900a45e1c3c","parentDoc":null,"isBodyEmpty":false,"children":[]}]}],"refs":[{"_id":"636c2fc543757a0082e0ea5e","title":"Start Here","slug":"general","order":1,"reference":true,"project":"6356ce887031fa001e26e989","version":"6356ce887031fa001e26e98e","createdAt":"2022-11-09T22:55:01.886Z","__v":0,"pages":[{"_id":"636c3005fcc97f00717ee772","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Standards & Concepts","icon":"","type":"basic","slug":"concepts","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-09T22:56:05.180Z","category":"636c2fc543757a0082e0ea5e","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"6411f36394a6670c1b616f12","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Environments","icon":"","type":"basic","slug":"environments","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"636c2fc543757a0082e0ea5e","createdAt":"2023-03-15T16:33:39.621Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"636c31696b4036001ddb06dc","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Getting Access","icon":"","type":"basic","slug":"getting-access","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-09T23:02:01.142Z","category":"636c2fc543757a0082e0ea5e","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"636c3180fef821000f578342","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Making Requests","icon":"","type":"basic","slug":"making-requests","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-09T23:02:24.565Z","category":"636c2fc543757a0082e0ea5e","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"636c31879eaaa30032f63124","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Error Codes","icon":"","type":"basic","slug":"error-codes","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-09T23:02:31.657Z","category":"636c2fc543757a0082e0ea5e","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"6374352f18b64e007e77d5d1","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Ledger Entry Codes","icon":"","type":"basic","slug":"ledger-entry-codes","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-16T00:56:15.599Z","category":"636c2fc543757a0082e0ea5e","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"636c2e44f41a34006b3b0db2","title":"API Reference","slug":"api-reference","order":3,"reference":true,"project":"6356ce887031fa001e26e989","version":"6356ce887031fa001e26e98e","createdAt":"2022-11-09T22:48:36.424Z","__v":0,"pages":[{"_id":"636c53051f4e650099a4d295","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Tokens","icon":"","type":"basic","slug":"tokens","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-10T01:25:25.914Z","category":"636c2e44f41a34006b3b0db2","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"63616321220398003cf6fb4a","api":{"method":"post","url":"/tokens","auth":"never","results":{"codes":[{"name":"","code":"{\n \"data\": [\n {\n \"policies\": [\n {\n \"policy\": \"id\",\n \"method\": \"inactive\",\n \"params\": [\n \"Tf2yXsY49iFyDfxt3b2kf9VPRMwPxxAyCRW\"\n ]\n }\n ],\n \"token\": \"G7XM9fcM1gtCN7DUr8ZWtPGVFLTKiYWanHR4kvqsnjP3\",\n \"facade\": \"merchant\",\n \"label\": \"merchantwebsite.com\",\n \"dateCreated\": 1621340364865,\n \"pairingExpiration\": 1621426764865,\n \"pairingCode\": \"C4Lg7oW\"\n }\n ]\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"},{"name":"id","type":"string","enumValues":"","default":"","desc":"Client identity based on BitAuth identity protocol, also known as SIN (System Identification Number)","required":true,"in":"body","ref":"","_id":"636c50f41dfbc5045d19101f"},{"name":"facade","type":"string","enumValues":"","default":"pos","desc":"Can be `merchant`, `pos`, or `payout`. If passed in the body of the request together with the id parameter, leave the pairingCode parameter out.","required":false,"in":"body","ref":"","_id":"636c50f41dfbc5045d19101e"},{"name":"label","type":"string","enumValues":"","default":"","desc":"Optional. Token label, may include spaces, underscores, and dashes. BitPay invites the merchants to pass their Business Name or website in this field.","required":false,"in":"body","ref":"","_id":"636c5171d01c3d00a4119e79"},{"name":"pairingCode","type":"string","enumValues":"","default":"","desc":"Optional.<br/><ul><li><b>Client Initiated Pairing</b>: If you do not pass a pairing code in the body of the request, you need to send the `id` and `facade` parameters. This will allow you to request API tokens with higher privileges (`merchant`, or `payout` facades) </li><li><b>Server Initiated Pairing</b>: If you pass a pairing code in the body of the request, leave the <code>facade</code> parameter out. The pairing code which can be generated from the <a href=\"https://test.bitpay.com/dashboard/merchant/api-tokens\" target=\"_blank\">BitPay dashboard</a> (with `\"Require Authentication\"` enabled) only allows you to request a `pos` facade token with authentication, meaning it will be necessary to cryptographically sign every request using this token, just like the other facades with higher privileges.</li></ul>","required":false,"in":"body","ref":"","_id":"636c5171d01c3d00a4119e78"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Request an API Token","icon":"","type":"endpoint","slug":"get-token","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-01T18:19:13.768Z","category":"636c2e44f41a34006b3b0db2","parentDoc":"636c53051f4e650099a4d295","isBodyEmpty":false,"children":[]},{"_id":"636c53c1be0d3d039408a312","api":{"method":"get","url":"/tokens","auth":"never","results":{"codes":[{"name":"","code":"{\n \"data\": [\n {\n \"merchant\": \"MqA2wX15qHCbG7FBtJZRAxQunrRjAvGBRVJedsiTnZY\"\n },\n {\n \"payout\": \"3LKKrrNB2BcVAu2Y24QQ78GrKUk2ANLK4eLo85Q1a2HU\"\n }\n ]\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191021"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191020"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Retrieve Approved API Tokens","icon":"","type":"endpoint","slug":"retrieve-approved-api-tokens","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"636c53051f4e650099a4d295","createdAt":"2022-11-10T01:28:33.598Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":false,"children":[]},{"_id":"636c548f46cc0300350fbc68","api":{"method":"get","url":"/tokens/{token}/sins","auth":"never","results":{"codes":[{"name":"","code":"{\n \"data\": {\n \"sins\": [\n \"Tf2yXsY49iFyDfxt3b2kf9VPRMwPxxAyCRW\"\n ]\n }\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191021"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191020"},{"name":"token","type":"string","enumValues":"","default":"","desc":"Approved API token for which you would like to view the linked SIN(s).","required":false,"in":"path","ref":"","_id":"636c54ba212e49001e84700e"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"View the SIN(s) Linked to an Approved Token","icon":"","type":"endpoint","slug":"view-the-sins-linked-to-an-approved-token","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"636c53051f4e650099a4d295","createdAt":"2022-11-10T01:31:59.200Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":false,"children":[]},{"_id":"636c54e3e2509d00689b46c7","api":{"method":"post","url":"/tokens/{token}/sins","auth":"never","results":{"codes":[{"name":"","code":"{\n \"data\": {\n \"success\": true\n }\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191021"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191020"},{"name":"token","type":"string","enumValues":"","default":"","desc":"Approved API token for which you would like to link a new SIN.","required":false,"in":"path","ref":"","_id":"636c54ba212e49001e84700e"},{"name":"sin","type":"string","enumValues":"","default":"","desc":"SIN value.","required":true,"in":"body","ref":"","_id":"636c54fd56b28500a8be92a7"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Link a New SIN to an Approved Token","icon":"","type":"endpoint","slug":"link-a-new-sin-to-an-approved-token","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"636c53051f4e650099a4d295","createdAt":"2022-11-10T01:33:23.884Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":false,"children":[]},{"_id":"636c554b7b2cc3003119b32f","api":{"method":"delete","url":"/tokens/{token}/sins/{sin}","auth":"never","results":{"codes":[{"name":"","code":"{\n \"data\": {\n \"success\": true\n }\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191021"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191020"},{"name":"token","type":"string","enumValues":"","default":"","desc":"Approved API token from which you would like to unlink a SIN.","required":false,"in":"path","ref":"","_id":"636c54ba212e49001e84700e"},{"name":"sin","type":"string","enumValues":"","default":"","desc":"SIN to be unlinked.","required":false,"in":"path","ref":"","_id":"636c556e09cf88004073183f"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Remove an SIN to an Approved Token","icon":"","type":"endpoint","slug":"remove-an-sin-to-an-approved-token","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"636c53051f4e650099a4d295","createdAt":"2022-11-10T01:35:07.310Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":false,"children":[]}]},{"_id":"636c55f800204c00917a96fd","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Invoices","icon":"","type":"basic","slug":"invoices","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-10T01:38:00.217Z","category":"636c2e44f41a34006b3b0db2","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"637415d9dc9067002bd95df3","api":{"method":"post","url":"/invoices","auth":"required","results":{"codes":[{"name":"pos facade","code":"{\n \"facade\": \"pos/invoice\",\n \"data\": {\n \"url\": \"https://bitpay.com/invoice?id=KSnNNfoMDsbRzd1U9ypmVH\",\n \"posData\": \"\\\"{ \\\"ref\\\" : 711454, \\\"item\\\" : \\\"test_item\\\" }\\\"\",\n \"status\": \"new\",\n \"price\": 20,\n \"currency\": \"USD\",\n \"itemDesc\": \"Item 1\",\n \"orderId\": \"20210511_abcde\",\n \"invoiceTime\": 1620734545366,\n \"expirationTime\": 1620735445366,\n \"currentTime\": 1620734545415,\n \"guid\": \"payment#1234\",\n \"id\": \"KSnNNfoMDsbRzd1U9ypmVH\",\n \"lowFeeDetected\": false,\n \"amountPaid\": 0,\n \"displayAmountPaid\": \"0\",\n \"exceptionStatus\": false,\n \"closeURL\": \"https://merchantwebsite.com/shop/cancel\",\n \"redirectURL\": \"https://merchantwebsite.com/shop/return\",\n \"autoRedirect\": false,\n \"refundAddressRequestPending\": false,\n \"buyerProvidedInfo\": {\n \"emailAddress\": \"john@doe.com\",\n \"selectedWallet\": \"bitpay\",\n \"selectedTransactionCurrency\": \"BTC\"\n },\n \"paymentSubtotals\": {\n \"BTC\": 18200,\n \"BCH\": 744500,\n \"ETH\": 2535000000000000,\n \"GUSD\": 1000,\n \"PAX\": 10000000000000000000,\n \"BUSD\": 10000000000000000000,\n \"USDC\": 10000000,\n \"XRP\": 7084249,\n \"DOGE\": 2068707100,\n \"DAI\": 9990000000000000000,\n \"WBTC\": 18100\n },\n \"paymentTotals\": {\n \"BTC\": 29800,\n \"BCH\": 744500,\n \"ETH\": 2535000000000000,\n \"GUSD\": 1000,\n \"PAX\": 10000000000000000000,\n \"BUSD\": 10000000000000000000,\n \"USDC\": 10000000,\n \"XRP\": 7084249,\n \"DOGE\": 2068707100,\n \"DAI\": 9990000000000000000,\n \"WBTC\": 18100\n },\n \"paymentDisplayTotals\": {\n \"BTC\": \"0.000298\",\n \"BCH\": \"0.007445\",\n \"ETH\": \"0.002535\",\n \"GUSD\": \"10.00\",\n \"PAX\": \"10.00\",\n \"BUSD\": \"10.00\",\n \"USDC\": \"10.00\",\n \"XRP\": \"7.084249\",\n \"DOGE\": \"20.687071\",\n \"DAI\": \"9.99\",\n \"WBTC\": \"0.000181\"\n },\n \"paymentDisplaySubTotals\": {\n \"BTC\": \"0.000182\",\n \"BCH\": \"0.007445\",\n \"ETH\": \"0.002535\",\n \"GUSD\": \"10.00\",\n \"PAX\": \"10.00\",\n \"BUSD\": \"10.00\",\n \"USDC\": \"10.00\",\n \"XRP\": \"7.084249\",\n \"DOGE\": \"20.687071\",\n \"DAI\": \"9.99\",\n \"WBTC\": \"0.000181\"\n },\n \"exchangeRates\": {\n \"BTC\": {\n \"USD\": 55072.459995,\n \"EUR\": 45287.42496000001,\n \"BCH\": 40.884360403999914,\n \"ETH\": 13.953840617367156,\n \"GUSD\": 55072.459995,\n \"PAX\": 55072.459995,\n \"BUSD\": 55072.459995,\n \"USDC\": 55072.459995,\n \"XRP\": 38907.54307403195,\n \"DOGE\": 113694.39064944115,\n \"DAI\": 55018.486859390934,\n \"WBTC\": 0.9983514430763876\n },\n \"BCH\": {\n \"USD\": 1343.1537000000003,\n \"EUR\": 1104.481875,\n \"BTC\": 0.02437664632426631,\n \"ETH\": 0.34031805835672807,\n \"GUSD\": 1343.1537000000003,\n \"PAX\": 1343.1537000000003,\n \"BUSD\": 1343.1537000000003,\n \"USDC\": 1343.1537000000003,\n \"XRP\": 948.9100440136494,\n \"DOGE\": 2772.8748903518513,\n \"DAI\": 1341.8373575522414,\n \"WBTC\": 0.024348638771359274\n },\n \"ETH\": {\n \"USD\": 3944.6466899999996,\n \"EUR\": 3242.8077850000004,\n \"BTC\": 0.07159065804331831,\n \"BCH\": 2.9284029977060646,\n \"GUSD\": 3944.6466899999996,\n \"PAX\": 3944.6466899999996,\n \"BUSD\": 3944.6466899999996,\n \"USDC\": 3944.6466899999996,\n \"XRP\": 2786.8105223000134,\n \"DOGE\": 8143.529484384802,\n \"DAI\": 3940.7807840508463,\n \"WBTC\": 0.07150840394174397\n },\n \"GUSD\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018148813739087574,\n \"BCH\": 0.0007423739634603535,\n \"ETH\": 0.0002533723864638336,\n \"PAX\": 1,\n \"BUSD\": 1,\n \"USDC\": 1,\n \"XRP\": 0.7064791200096081,\n \"DOGE\": 2.0644509190212936,\n \"DAI\": 0.9990199614178492,\n \"WBTC\": 0.000018127961655735506\n },\n \"PAX\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018148813739087574,\n \"BCH\": 0.0007423739634603535,\n \"ETH\": 0.0002533723864638336,\n \"GUSD\": 1,\n \"BUSD\": 1,\n \"USDC\": 1,\n \"XRP\": 0.7064791200096081,\n \"DOGE\": 2.0644509190212936,\n \"DAI\": 0.9990199614178492,\n \"WBTC\": 0.000018127961655735506\n },\n \"BUSD\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018148813739087574,\n \"BCH\": 0.0007423739634603535,\n \"ETH\": 0.0002533723864638336,\n \"GUSD\": 1,\n \"PAX\": 1,\n \"USDC\": 1,\n \"XRP\": 0.7064791200096081,\n \"DOGE\": 2.0644509190212936,\n \"DAI\": 0.9990199614178492,\n \"WBTC\": 0.000018127961655735506\n },\n \"USDC\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018148813739087574,\n \"BCH\": 0.0007423739634603535,\n \"ETH\": 0.0002533723864638336,\n \"GUSD\": 1,\n \"PAX\": 1,\n \"BUSD\": 1,\n \"XRP\": 0.7064791200096081,\n \"DOGE\": 2.0644509190212936,\n \"DAI\": 0.9990199614178492,\n \"WBTC\": 0.000018127961655735506\n },\n \"XRP\": {\n \"USD\": 1.4115822,\n \"EUR\": 1.1595738,\n \"BTC\": 0.000025618542425211465,\n \"BCH\": 0.0010479218725640857,\n \"ETH\": 0.00035765595070386846,\n \"GUSD\": 1.4115822,\n \"PAX\": 1.4115822,\n \"BUSD\": 1.4115822,\n \"USDC\": 1.4115822,\n \"DOGE\": 2.9141421700640993,\n \"DAI\": 1.4101987949821229,\n \"WBTC\": 0.000025589107995518766\n },\n \"DOGE\": {\n \"USD\": 0.48339370000000004,\n \"EUR\": 0.3971920350538,\n \"BTC\": 0.000008773022223948377,\n \"BCH\": 0.0003588588969807651,\n \"ETH\": 0.00012247861537058246,\n \"GUSD\": 0.48339370000000004,\n \"PAX\": 0.48339370000000004,\n \"BUSD\": 0.48339370000000004,\n \"USDC\": 0.48339370000000004,\n \"XRP\": 0.3415075557941885,\n \"DAI\": 0.4829199555236314,\n \"WBTC\": 0.000008762942458224111\n },\n \"DAI\": {\n \"USD\": 1.000977,\n \"EUR\": 0.822476775498,\n \"BTC\": 0.00001816654513011066,\n \"BCH\": 0.0007430992628226543,\n \"ETH\": 0.0002536199312854088,\n \"GUSD\": 1.000977,\n \"PAX\": 1.000977,\n \"BUSD\": 1.000977,\n \"USDC\": 1.000977,\n \"XRP\": 0.7071693501098576,\n \"DOGE\": 2.066467887569177,\n \"WBTC\": 0.00001814567267427316\n },\n \"WBTC\": {\n \"USD\": 55122.38,\n \"EUR\": 45292.626464119996,\n \"BTC\": 1.0004058074752062,\n \"BCH\": 40.92141971596772,\n \"ETH\": 13.966488968166292,\n \"GUSD\": 55122.38,\n \"PAX\": 55122.38,\n \"BUSD\": 55122.38,\n \"USDC\": 55122.38,\n \"XRP\": 38942.81051523522,\n \"DOGE\": 113797.44804964097,\n \"DAI\": 55068.35794086002\n }\n },\n \"supportedTransactionCurrencies\": {\n \"BTC\": {\n \"enabled\": true\n },\n \"BCH\": {\n \"enabled\": true\n },\n \"ETH\": {\n \"enabled\": true\n },\n \"GUSD\": {\n \"enabled\": true\n },\n \"PAX\": {\n \"enabled\": true\n },\n \"BUSD\": {\n \"enabled\": true\n },\n \"USDC\": {\n \"enabled\": false,\n\t\t\t\t\t\"reason\": \"restrictedByCustomerLocation\"\n },\n \"XRP\": {\n \"enabled\": true\n },\n \"DOGE\": {\n \"enabled\": true\n },\n \"DAI\": {\n \"enabled\": true\n },\n \"WBTC\": {\n \"enabled\": true\n }\n },\n \"minerFees\": {\n \"BTC\": {\n \"satoshisPerByte\": 1,\n \"totalFee\": 100,\n \"fiatAmount\": 0.02\n },\n \"BCH\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"ETH\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"GUSD\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"PAX\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"BUSD\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"USDC\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"XRP\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"DOGE\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"DAI\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"WBTC\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n }\n },\n \"jsonPayProRequired\": false,\n \"itemizedDetails\": [\n {\n \"amount\": 5,\n \"description\": \"Item 1\",\n \"isFee\": false\n },\n {\n \"amount\": 15,\n \"description\": \"Item 2\",\n \"isFee\": false\n }\n ],\n \"universalCodes\": {\n \"paymentString\": \"https://link.bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\"\n },\n \"merchantName\": \"Test Merchant\",\n \"paymentCodes\": {\n \"BTC\": {\n \"BIP72b\": \"bitcoin:?r=https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\",\n \"BIP73\": \"https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\"\n },\n \"BCH\": {\n \"BIP72b\": \"bitcoincash:?r=https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\",\n \"BIP73\": \"https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\"\n },\n \"ETH\": {\n \"EIP681\": \"ethereum:?r=https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\"\n },\n \"GUSD\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\"\n },\n \"PAX\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\"\n },\n \"BUSD\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\"\n },\n \"USDC\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\"\n },\n \"XRP\": {\n \"BIP72b\": \"ripple:?r=https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\",\n \"BIP73\": \"https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\",\n \"RIP681\": \"https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\"\n },\n \"DOGE\": {\n \"BIP72b\": \"dogecoin:?r=https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\",\n \"BIP73\": \"https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\"\n },\n \"DAI\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\"\n },\n \"WBTC\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\"\n }\n },\n \"token\": \"8nPJSGgi7omxcbGGZ4KsSgqdi6juypBe9pVpSURDeAwx4VDQx1XfWPy5qqknDKT9KQ\"\n }\n}","language":"json","status":200},{"code":"{\n \"facade\": \"merchant/invoice\",\n \"data\": {\n \"url\": \"https://bitpay.com/invoice?id=G3viJEJgE8Jk2oekSdgT2A\",\n \"posData\": \"\\\"{ \\\"ref\\\" : 711454, \\\"item\\\" : \\\"test_item\\\" }\\\"\",\n \"status\": \"new\",\n \"price\": 20,\n \"currency\": \"USD\",\n \"itemDesc\": \"Item 1\",\n \"orderId\": \"20210511_fghij\",\n \"invoiceTime\": 1620733980748,\n \"expirationTime\": 1620734880748,\n \"currentTime\": 1620733980807,\n \"guid\": \"payment#1234\",\n \"id\": \"G3viJEJgE8Jk2oekSdgT2A\",\n \"lowFeeDetected\": false,\n \"amountPaid\": 0,\n \"displayAmountPaid\": \"0\",\n \"exceptionStatus\": false,\n \"targetConfirmations\": 6,\n \"transactions\": [],\n \"transactionSpeed\": \"medium\",\n \"buyer\": {\n \"email\": \"john@doe.com\"\n },\n \"redirectURL\": \"https://merchantwebsite.com/shop/return\",\n \"autoRedirect\": false,\n \"closeURL\": \"https://merchantwebsite.com/shop/cancel\",\n \"refundAddresses\": [\n {\n \"refund-address-here\": {\n \"type\": \"coinbase\",\n \"date\": \"2024-01-08T23:50:56.556Z\",\n \"email\": \"email@email.com\"\n }\n }\n ],\n \"refundAddressRequestPending\": false,\n \"buyerProvidedEmail\": \"john@doe.com\",\n \"buyerProvidedInfo\": {\n \"emailAddress\": \"john@doe.com\",\n \"selectedWallet\": \"bitpay\",\n \"selectedTransactionCurrency\": \"BTC\"\n },\n \"paymentSubtotals\": {\n \"BTC\": 18000,\n \"BCH\": 739100,\n \"ETH\": 2505000000000000,\n \"GUSD\": 1000,\n \"PAX\": 10000000000000000000,\n \"BUSD\": 10000000000000000000,\n \"USDC\": 10000000,\n \"XRP\": 7015685,\n \"DOGE\": 1998865000,\n \"DAI\": 9990000000000000000,\n \"WBTC\": 18000\n },\n \"paymentTotals\": {\n \"BTC\": 29600,\n \"BCH\": 739100,\n \"ETH\": 2505000000000000,\n \"GUSD\": 1000,\n \"PAX\": 10000000000000000000,\n \"BUSD\": 10000000000000000000,\n \"USDC\": 10000000,\n \"XRP\": 7015685,\n \"DOGE\": 1998865000,\n \"DAI\": 9990000000000000000,\n \"WBTC\": 18000\n },\n \"paymentDisplayTotals\": {\n \"BTC\": \"0.000296\",\n \"BCH\": \"0.007391\",\n \"ETH\": \"0.002505\",\n \"GUSD\": \"10.00\",\n \"PAX\": \"10.00\",\n \"BUSD\": \"10.00\",\n \"USDC\": \"10.00\",\n \"XRP\": \"7.015685\",\n \"DOGE\": \"19.988650\",\n \"DAI\": \"9.99\",\n \"WBTC\": \"0.000180\"\n },\n \"paymentDisplaySubTotals\": {\n \"BTC\": \"0.000180\",\n \"BCH\": \"0.007391\",\n \"ETH\": \"0.002505\",\n \"GUSD\": \"10.00\",\n \"PAX\": \"10.00\",\n \"BUSD\": \"10.00\",\n \"USDC\": \"10.00\",\n \"XRP\": \"7.015685\",\n \"DOGE\": \"19.988650\",\n \"DAI\": \"9.99\",\n \"WBTC\": \"0.000180\"\n },\n \"exchangeRates\": {\n \"BTC\": {\n \"USD\": 55413.609335,\n \"EUR\": 45540.39841,\n \"BCH\": 40.84109737914668,\n \"ETH\": 13.870219975470258,\n \"GUSD\": 55413.609335,\n \"PAX\": 55413.609335,\n \"BUSD\": 55413.609335,\n \"USDC\": 55413.609335,\n \"XRP\": 38758.09372049268,\n \"DOGE\": 110606.00665668662,\n \"DAI\": 55359.96552840298,\n \"WBTC\": 0.9981333606461704\n },\n \"BCH\": {\n \"USD\": 1352.90925,\n \"EUR\": 1111.2150000000001,\n \"BTC\": 0.02440102556111244,\n \"ETH\": 0.33863791096704754,\n \"GUSD\": 1352.90925,\n \"PAX\": 1352.90925,\n \"BUSD\": 1352.90925,\n \"USDC\": 1352.90925,\n \"XRP\": 946.2690507998013,\n \"DOGE\": 2700.4176646706587,\n \"DAI\": 1351.599550036015,\n \"WBTC\": 0.024369173431532262\n },\n \"ETH\": {\n \"USD\": 3992.672665000001,\n \"EUR\": 3278.9696950000002,\n \"BTC\": 0.0720117094001833,\n \"BCH\": 2.9426910658087726,\n \"GUSD\": 3992.672665000001,\n \"PAX\": 3992.672665000001,\n \"BUSD\": 3992.672665000001,\n \"USDC\": 3992.672665000001,\n \"XRP\": 2792.6060619837313,\n \"DOGE\": 7969.406516966069,\n \"DAI\": 3988.807510522304,\n \"WBTC\": 0.07191770817497412\n },\n \"GUSD\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"PAX\": 1,\n \"BUSD\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"PAX\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"BUSD\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"BUSD\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"PAX\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"USDC\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"PAX\": 1,\n \"BUSD\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"XRP\": {\n \"USD\": 1.4253776249999999,\n \"EUR\": 1.17088545,\n \"BTC\": 0.00002570806272620483,\n \"BCH\": 0.0010505359077542177,\n \"ETH\": 0.0003567769983605121,\n \"GUSD\": 1.4253776249999999,\n \"PAX\": 1.4253776249999999,\n \"BUSD\": 1.4253776249999999,\n \"USDC\": 1.4253776249999999,\n \"DOGE\": 2.845065119760479,\n \"DAI\": 1.423997771159746,\n \"WBTC\": 0.00002567450444222371\n },\n \"DOGE\": {\n \"USD\": 0.5002839,\n \"EUR\": 0.4110702732486,\n \"BTC\": 0.000009023103531676658,\n \"BCH\": 0.0003687206757025671,\n \"ETH\": 0.00012522280765428083,\n \"GUSD\": 0.5002839,\n \"PAX\": 0.5002839,\n \"BUSD\": 0.5002839,\n \"USDC\": 0.5002839,\n \"XRP\": 0.3499149489763802,\n \"DAI\": 0.49979959419322684,\n \"WBTC\": 0.000009011325130716152\n },\n \"DAI\": {\n \"USD\": 1.000968,\n \"EUR\": 0.822469380432,\n \"BTC\": 0.000018053425057043255,\n \"BCH\": 0.0007377363079576361,\n \"ETH\": 0.00025054578676645436,\n \"GUSD\": 1.000968,\n \"PAX\": 1.000968,\n \"BUSD\": 1.000968,\n \"USDC\": 1.000968,\n \"XRP\": 0.7001098109433249,\n \"DOGE\": 1.9979401197604791,\n \"WBTC\": 0.000018029858833039973\n },\n \"WBTC\": {\n \"USD\": 55466.58,\n \"EUR\": 45575.44665492,\n \"BTC\": 1.000393364423732,\n \"BCH\": 40.88013797068123,\n \"ETH\": 13.883478717945511,\n \"GUSD\": 55466.58,\n \"PAX\": 55466.58,\n \"BUSD\": 55466.58,\n \"USDC\": 55466.58,\n \"XRP\": 38795.14313891434,\n \"DOGE\": 110711.73652694612,\n \"DAI\": 55412.88491451783\n }\n },\n \"minerFees\": {\n \"BTC\": {\n \"satoshisPerByte\": 1,\n \"totalFee\": 100,\n \"fiatAmount\": 0.02\n },\n \"BCH\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"ETH\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"GUSD\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"PAX\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"BUSD\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"USDC\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"XRP\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"DOGE\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"DAI\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"WBTC\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n }\n },\n \"shopper\": {},\n \"jsonPayProRequired\": false,\n \"merchantName\": \"Test Merchant\",\n \"bitpayIdRequired\": false,\n \"itemizedDetails\": [\n {\n \"amount\": 5,\n \"description\": \"Item 1\",\n \"isFee\": false\n },\n {\n \"amount\": 15,\n \"description\": \"Item 2\",\n \"isFee\": false\n }\n ],\n \"supportedTransactionCurrencies\": {\n \"BTC\": {\n \"enabled\": true\n },\n \"BCH\": {\n \"enabled\": true\n },\n \"ETH\": {\n \"enabled\": true\n },\n \"GUSD\": {\n \"enabled\": true\n },\n \"PAX\": {\n \"enabled\": true\n },\n \"BUSD\": {\n \"enabled\": true\n },\n \"USDC\": {\n \"enabled\": false,\n\t\t\t\t\t\"reason\": \"restrictedByCustomerLocation\"\n },\n \"XRP\": {\n \"enabled\": true\n },\n \"DOGE\": {\n \"enabled\": true\n },\n \"DAI\": {\n \"enabled\": true\n },\n \"WBTC\": {\n \"enabled\": true\n }\n },\n \"paymentCodes\": {\n \"BTC\": {\n \"BIP72b\": \"bitcoin:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"BCH\": {\n \"BIP72b\": \"bitcoincash:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"ETH\": {\n \"EIP681\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"GUSD\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"PAX\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"BUSD\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"USDC\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"XRP\": {\n \"BIP72b\": \"ripple:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"RIP681\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"DOGE\": {\n \"BIP72b\": \"dogecoin:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"DAI\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"WBTC\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n }\n },\n \"universalCodes\": {\n \"paymentString\": \"https://link.bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"token\": \"Svbfdow1xXc6chtQB3GVKqyRVhyLMqn3nhMhyTtf9T9vTCDKrVfdoA7n94nZUECZf\"\n }\n}","language":"json","status":200,"name":"merchant facade"}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374167755cb9c00294ec5f0"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374164ec038610040ebede4"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":false,"in":"header","ref":"","_id":"6374168a18b64e007e759b80"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":false,"in":"header","ref":"","_id":"637416dbf2ff62001097f3b1"},{"name":"token","type":"string","enumValues":"","default":"","desc":"The API token can be retrieved from the dashboard (limited to pos facade) or using the Tokens resource to get access to the merchant facade. This is described in the section Request an API token).","required":true,"in":"body","ref":"","_id":"637419ebe42f06001e11f07c"},{"name":"price","type":"double","enumValues":"","default":"","desc":"Fixed price amount for the checkout, in the \"currency\" of the invoice object.","required":false,"in":"body","ref":"","_id":"637419ebe42f06001e11f07b"},{"name":"currency","type":"string","enumValues":"","default":"","desc":"ISO 4217 3-character currency code. This is the currency associated with the price field, supported currencies are available via the Currencies resource.","required":true,"in":"body","ref":"","_id":"637419ebe42f06001e11f07a"},{"name":"bitpayIdRequired","type":"boolean","enumValues":"","default":"","desc":"Forces the invoice to require BitPay ID to be completed, regardless of price.","required":false,"in":"body","ref":"","_id":"637419ebe42f06001e11f079"},{"name":"merchantName","type":"string","enumValues":"","default":"","desc":"Display string for merchant identification (ex. Wal-Mart Store #1452, Bowling Green, KY).","required":false,"in":"body","ref":"","_id":"637419ebe42f06001e11f078"},{"name":"forcedBuyerSelectedTransactionCurrency","type":"string","enumValues":"","default":"","desc":"Merchant pre-selects transaction currency on behalf of buyer.","required":false,"in":"body","ref":"","_id":"637419ebe42f06001e11f077"},{"name":"forcedBuyerSelectedWallet","type":"string","enumValues":"","default":"","desc":"Merchant pre-selects wallet on behalf of buyer.","required":false,"in":"body","ref":"","_id":"637419ebe42f06001e11f076"},{"name":"orderId","type":"string","enumValues":"","default":"","desc":"Can be used by the merchant to assign their own internal Id to an invoice. If used, there should be a direct match between an orderId and an invoice id.","required":false,"in":"body","ref":"","_id":"637419ebe42f06001e11f075"},{"name":"itemDesc","type":"string","enumValues":"","default":"","desc":"Invoice description - will be added as a line item on the BitPay checkout page, under the merchant name.","required":false,"in":"body","ref":"","_id":"637419ebe42f06001e11f074"},{"name":"itemCode","type":"string","enumValues":"","default":"","desc":"\"bitcoindonation\" for donations, otherwise do not include the field in the request.","required":false,"in":"body","ref":"","_id":"637419ebe42f06001e11f073"},{"name":"itemizedDetails","type":"object","enumValues":"","default":"","desc":"Object containing line item details for display.","required":false,"in":"body","ref":"itemizedDetails","_id":"637419ebe42f06001e11f072"},{"name":"notificationEmail","type":"string","enumValues":"","default":"","desc":"Merchant email address for notification of invoice status change. It is also possible to configure this email via the account setting on the BitPay dashboard or disable the email notification","required":false,"in":"body","ref":"","_id":"63741a9c4e87210086f7a1e3"},{"name":"notificationURL","type":"string","enumValues":"","default":"","desc":"URL to which BitPay sends webhook notifications. HTTPS is mandatory.","required":false,"in":"body","ref":"","_id":"63741a9c4e87210086f7a1e2"},{"name":"redirectURL","type":"string","enumValues":"","default":"","desc":"The shopper will be redirected to this URL when clicking on the Return button after a successful payment or when clicking on the Close button if a separate closeURL is not specified. Be sure to include \"http://\" or \"https://\" in the url.","required":false,"in":"body","ref":"","_id":"63741a9c4e87210086f7a1e1"},{"name":"closeURL","type":"string","enumValues":"","default":"","desc":"URL to redirect if the shopper does not pay the invoice and click on the Close button instead. Be sure to include \"http://\" or \"https://\" in the url.","required":false,"in":"body","ref":"","_id":"63741a9c4e87210086f7a1e0"},{"name":"autoRedirect","type":"boolean","enumValues":"","default":"","desc":"<p>Set to `false` by default, merchant can setup automatic redirect to their website by setting this parameter to `true`. This will applied to the following scenarios:</p><ul><li>When the invoice is paid, it automatically redirects the shopper to the `redirectURL` indicated</li><li>When the invoice expires, it automatically redirects the shopper to the `closeURL` if specified and to the `redirectURL` otherwise</li></ul><p><b>Note</b>: If automatic redirect is enabled, `redirectURL` becomes a mandatory invoice parameters.</p>","required":false,"in":"body","ref":"","_id":"63741a9c4e87210086f7a1df"},{"name":"posData","type":"string","enumValues":"","default":"","desc":"A passthru variable provided by the merchant during invoice creation and designed to be used by the merchant to correlate the invoice with an order or other object in their system. This passthru variable can be a serialized object, e.g.: `\"posData\": \"\\\"{ \\\"ref\\\" : 711454, \\\"item\\\" : \\\"test_item\\\" }\\\"\"`.","required":false,"in":"body","ref":"","_id":"63741b97cbcb3f0050eed823"},{"name":"guid","type":"string","enumValues":"","default":"","desc":"A passthru variable provided by the merchant and designed to be used by the merchant to correlate the invoice with an order ID in their system, which can be used as a lookup variable in Retrieve Invoice by GUID.","required":false,"in":"body","ref":"","_id":"63741b97cbcb3f0050eed822"},{"name":"transactionSpeed","type":"string","enumValues":"","default":"","desc":"This is a risk mitigation parameter for the merchant to configure how they want to fulfill orders depending on the number of block confirmations for the transaction made by the consumer on the selected cryptocurrency.<ul><li><b>high</b>: The invoice is marked as \"confirmed\" by BitPay as soon as full payment is received but not yet validated on the corresponding blockchain. The invoice will go from a status of \"new\" to \"confirmed\", bypassing the \"paid\" status. If you want an immediate notification for a payment, you can use the high speed setting. However, it makes you more susceptible to receiving fraudulent payments, so it is not recommended.</li><li><b>medium</b>: (<i>Recommended for most merchants</i>) The invoice is marked as \"confirmed\" after the transaction has received basic confirmation on the corresponding blockchain. For invoices paid in Bitcoin (BTC), this means 1 confirmation on the blockchain which takes on average 10 minutes. The invoice will go from a status of \"new\" to \"paid\" followed by \"confirmed\" and then \"complete\"</li><li><b>low</b>: The invoice is marked as \"confirmed\" once BitPay has credited the funds to the merchant account. The invoice will go from a status of \"new\" to \"paid\" followed by \"complete\", thus bypassing the \"confirmed\" status. For invoices paid in Bitcoin (BTC), this means 6 confirmations on the blockchain which takes on average an hour</li></ul><p>If not set on the invoice, <code>transactionSpeed</code> will default to the <a href=\"https://test.bitpay.com/dashboard/settings/edit/order\" target=\"_blank\"> account-level Order Settings</a>.</p><p><b>Note :</b> orders are only credited to your BitPay Account Summary for settlement after the invoice reaches the status \"complete\" (regardless of this setting).</p>","required":false,"in":"body","ref":"","_id":"63741b97cbcb3f0050eed821"},{"name":"fullNotifications","type":"boolean","enumValues":"","default":"","desc":"This parameter is set to true by default, meaning all standard notifications are being sent for a payment made to an invoice. If you decide to set it to false instead, only 1 webhook will be sent for each invoice paid by the consumer. This webhook will be for the \"confirmed\" or \"complete\" invoice status, depending on the transactionSpeed selected.","required":false,"in":"body","ref":"","_id":"63741bc44e60c90016078735"},{"name":"extendedNotifications","type":"boolean","enumValues":"","default":"","desc":"Allows merchants to get access to additional webhooks. For instance when an invoice expires without receiving a payment or when it is refunded. If set to true, then fullNotifications is automatically set to true. When using the extendedNotifications parameter, the webhook also have a payload slightly different from the standard webhooks.","required":false,"in":"body","ref":"","_id":"63741bdb03106800717733c8"},{"name":"physical","type":"boolean","enumValues":"","default":"","desc":"Indicates whether items are physical goods. Alternatives include digital goods and services.","required":false,"in":"body","ref":"","_id":"63741bfb282c63002a56beff"},{"name":"buyerSms","type":"string","enumValues":"","default":"","desc":"SMS phone number including country code i.e. +12223334444.","required":false,"in":"body","ref":"","_id":"63741bfb282c63002a56befe"},{"name":"buyer","type":"object","enumValues":"","default":"","desc":"Allows merchant to pass buyer related information in the invoice object","required":false,"in":"body","ref":"buyer","_id":"63741cd8ae73690029ad34fd"},{"name":"jsonPayProRequired","type":"string","enumValues":"","default":"","desc":"If set to true, this means that the invoice will only accept payments from wallets which have implemented the BitPay JSON Payment Protocol","required":false,"in":"body","ref":"","_id":"63741cd8ae73690029ad34fc"},{"name":"acceptanceWindow","type":"int","enumValues":"","default":"","desc":"Number of milliseconds that a user has to pay an invoice before it expires (0-900000). If not set, invoice will default to the account acceptanceWindow. If account acceptanceWindow is not set, invoice will default to 15 minutes (900,000 milliseconds).","required":false,"in":"body","ref":"","_id":"63741cd8ae73690029ad34fb"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Create an Invoice","icon":"","type":"endpoint","slug":"create-an-invoice","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-15T22:42:33.517Z","parentDoc":"636c55f800204c00917a96fd","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]},{"_id":"63741e6c952332003820dca7","api":{"method":"put","url":"/invoices/{invoiceId}","auth":"required","results":{"codes":[{"name":"","code":"{\n \"facade\": \"merchant/invoice\",\n \"data\": {\n \"url\": \"https://bitpay.com/invoice?id=G3viJEJgE8Jk2oekSdgT2A\",\n \"posData\": \"\\\"{ \\\"ref\\\" : 711454, \\\"item\\\" : \\\"test_item\\\" }\\\"\",\n \"status\": \"confirmed\",\n \"price\": 20,\n \"currency\": \"USD\",\n \"orderId\": \"20210511_fghij\",\n \"invoiceTime\": 1620733980748,\n \"expirationTime\": 1620734880748,\n \"currentTime\": 1620734253073,\n \"guid\": \"payment#1234\",\n \"id\": \"G3viJEJgE8Jk2oekSdgT2A\",\n \"lowFeeDetected\": false,\n \"amountPaid\": 739100,\n \"displayAmountPaid\": \"0.007391\",\n \"exceptionStatus\": false,\n \"targetConfirmations\": 6,\n \"transactions\": [\n {\n \"amount\": 739100,\n \"confirmations\": 1,\n \"receivedTime\": \"2021-05-11T11:54:32.978Z\",\n \"txid\": \"0638edcce08856726135e4f464e603706bc12313fd9a9cd046a177e4ffce98dd\",\n \"exRates\": {\n \"BCH\": 1,\n \"USD\": 1355.2800000000002,\n \"BTC\": 0.02446472581430398,\n \"EUR\": 1112.66,\n \"ETH\": 0.33972366494876377,\n \"GUSD\": 1355.2800000000002,\n \"PAX\": 1355.2800000000002,\n \"BUSD\": 1355.2800000000002,\n \"USDC\": 1355.2800000000002,\n \"XRP\": 948.9227925474189,\n \"DOGE\": 2725.466119299674,\n \"DAI\": 1353.985589776174,\n \"WBTC\": 0.024436520994387978\n },\n \"outputIndex\": 0\n }\n ],\n \"transactionSpeed\": \"medium\",\n \"buyer\": {\n \"email\": \"john@doe.com\"\n },\n \"redirectURL\": \"https://merchantwebsite.com/shop/return\",\n \"autoRedirect\": false,\n \"closeURL\": \"https://merchantwebsite.com/shop/cancel\",\n \"refundAddresses\": [],\n \"refundAddressRequestPending\": false,\n \"buyerProvidedEmail\": \"john@doe.com\",\n \"buyerProvidedInfo\": {\n \"emailAddress\": \"john@doe.com\",\n \"sms\": \"+12223334444\",\n \"smsVerified\": true,\n \"selectedWallet\": \"bitpay\",\n \"selectedTransactionCurrency\": \"BCH\",\n \"emailAddress\": \"john@doe.com\"\n },\n \"paymentSubtotals\": {\n \"BTC\": 18000,\n \"BCH\": 739100,\n \"ETH\": 2505000000000000,\n \"GUSD\": 1000,\n \"PAX\": 10000000000000000000,\n \"BUSD\": 10000000000000000000,\n \"USDC\": 10000000,\n \"XRP\": 7015685,\n \"DOGE\": 1998865000,\n \"DAI\": 9990000000000000000,\n \"WBTC\": 18000\n },\n \"paymentTotals\": {\n \"BTC\": 29600,\n \"BCH\": 739100,\n \"ETH\": 2505000000000000,\n \"GUSD\": 1000,\n \"PAX\": 10000000000000000000,\n \"BUSD\": 10000000000000000000,\n \"USDC\": 10000000,\n \"XRP\": 7015685,\n \"DOGE\": 1998865000,\n \"DAI\": 9990000000000000000,\n \"WBTC\": 18000\n },\n \"paymentDisplayTotals\": {\n \"BTC\": \"0.000296\",\n \"BCH\": \"0.007391\",\n \"ETH\": \"0.002505\",\n \"GUSD\": \"10.00\",\n \"PAX\": \"10.00\",\n \"BUSD\": \"10.00\",\n \"USDC\": \"10.00\",\n \"XRP\": \"7.015685\",\n \"DOGE\": \"19.988650\",\n \"DAI\": \"9.99\",\n \"WBTC\": \"0.000180\"\n },\n \"paymentDisplaySubTotals\": {\n \"BTC\": \"0.000180\",\n \"BCH\": \"0.007391\",\n \"ETH\": \"0.002505\",\n \"GUSD\": \"10.00\",\n \"PAX\": \"10.00\",\n \"BUSD\": \"10.00\",\n \"USDC\": \"10.00\",\n \"XRP\": \"7.015685\",\n \"DOGE\": \"19.988650\",\n \"DAI\": \"9.99\",\n \"WBTC\": \"0.000180\"\n },\n \"exchangeRates\": {\n \"BTC\": {\n \"USD\": 55413.609335,\n \"EUR\": 45540.39841,\n \"BCH\": 40.84109737914668,\n \"ETH\": 13.870219975470258,\n \"GUSD\": 55413.609335,\n \"PAX\": 55413.609335,\n \"BUSD\": 55413.609335,\n \"USDC\": 55413.609335,\n \"XRP\": 38758.09372049268,\n \"DOGE\": 110606.00665668662,\n \"DAI\": 55359.96552840298,\n \"WBTC\": 0.9981333606461704\n },\n \"BCH\": {\n \"USD\": 1352.90925,\n \"EUR\": 1111.2150000000001,\n \"BTC\": 0.02440102556111244,\n \"ETH\": 0.33863791096704754,\n \"GUSD\": 1352.90925,\n \"PAX\": 1352.90925,\n \"BUSD\": 1352.90925,\n \"USDC\": 1352.90925,\n \"XRP\": 946.2690507998013,\n \"DOGE\": 2700.4176646706587,\n \"DAI\": 1351.599550036015,\n \"WBTC\": 0.024369173431532262\n },\n \"ETH\": {\n \"USD\": 3992.672665000001,\n \"EUR\": 3278.9696950000002,\n \"BTC\": 0.0720117094001833,\n \"BCH\": 2.9426910658087726,\n \"GUSD\": 3992.672665000001,\n \"PAX\": 3992.672665000001,\n \"BUSD\": 3992.672665000001,\n \"USDC\": 3992.672665000001,\n \"XRP\": 2792.6060619837313,\n \"DOGE\": 7969.406516966069,\n \"DAI\": 3988.807510522304,\n \"WBTC\": 0.07191770817497412\n },\n \"GUSD\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"PAX\": 1,\n \"BUSD\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"PAX\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"BUSD\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"BUSD\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"PAX\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"USDC\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"PAX\": 1,\n \"BUSD\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"XRP\": {\n \"USD\": 1.4253776249999999,\n \"EUR\": 1.17088545,\n \"BTC\": 0.00002570806272620483,\n \"BCH\": 0.0010505359077542177,\n \"ETH\": 0.0003567769983605121,\n \"GUSD\": 1.4253776249999999,\n \"PAX\": 1.4253776249999999,\n \"BUSD\": 1.4253776249999999,\n \"USDC\": 1.4253776249999999,\n \"DOGE\": 2.845065119760479,\n \"DAI\": 1.423997771159746,\n \"WBTC\": 0.00002567450444222371\n },\n \"DOGE\": {\n \"USD\": 0.5002839,\n \"EUR\": 0.4110702732486,\n \"BTC\": 0.000009023103531676658,\n \"BCH\": 0.0003687206757025671,\n \"ETH\": 0.00012522280765428083,\n \"GUSD\": 0.5002839,\n \"PAX\": 0.5002839,\n \"BUSD\": 0.5002839,\n \"USDC\": 0.5002839,\n \"XRP\": 0.3499149489763802,\n \"DAI\": 0.49979959419322684,\n \"WBTC\": 0.000009011325130716152\n },\n \"DAI\": {\n \"USD\": 1.000968,\n \"EUR\": 0.822469380432,\n \"BTC\": 0.000018053425057043255,\n \"BCH\": 0.0007377363079576361,\n \"ETH\": 0.00025054578676645436,\n \"GUSD\": 1.000968,\n \"PAX\": 1.000968,\n \"BUSD\": 1.000968,\n \"USDC\": 1.000968,\n \"XRP\": 0.7001098109433249,\n \"DOGE\": 1.9979401197604791,\n \"WBTC\": 0.000018029858833039973\n },\n \"WBTC\": {\n \"USD\": 55466.58,\n \"EUR\": 45575.44665492,\n \"BTC\": 1.000393364423732,\n \"BCH\": 40.88013797068123,\n \"ETH\": 13.883478717945511,\n \"GUSD\": 55466.58,\n \"PAX\": 55466.58,\n \"BUSD\": 55466.58,\n \"USDC\": 55466.58,\n \"XRP\": 38795.14313891434,\n \"DOGE\": 110711.73652694612,\n \"DAI\": 55412.88491451783\n }\n },\n \"minerFees\": {\n \"BTC\": {\n \"satoshisPerByte\": 1,\n \"totalFee\": 100,\n \"fiatAmount\": 0.02\n },\n \"BCH\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"ETH\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"GUSD\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"PAX\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"BUSD\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"USDC\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"XRP\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"DOGE\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"DAI\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"WBTC\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n }\n },\n \"shopper\": {\n \"user\": \"FeFc5a7hUwmrEnYwVPmrkp\"\n },\n \"jsonPayProRequired\": false,\n \"merchantName\": \"Test Merchant\",\n \"bitpayIdRequired\": true,\n \"isCancelled\": false,\n \"itemizedDetails\": [\n {\n \"amount\": 5,\n \"description\": \"Item 1\",\n \"isFee\": false\n },\n {\n \"amount\": 15,\n \"description\": \"Item 2\",\n \"isFee\": false\n }\n ],\n \"transactionCurrency\": \"BCH\",\n \"supportedTransactionCurrencies\": {\n \"BTC\": {\n \"enabled\": true\n },\n \"BCH\": {\n \"enabled\": true\n },\n \"ETH\": {\n \"enabled\": true\n },\n \"GUSD\": {\n \"enabled\": true\n },\n \"PAX\": {\n \"enabled\": true\n },\n \"BUSD\": {\n \"enabled\": true\n },\n \"USDC\": {\n \"enabled\": true\n },\n \"XRP\": {\n \"enabled\": true\n },\n \"DOGE\": {\n \"enabled\": true\n },\n \"DAI\": {\n \"enabled\": true\n },\n \"WBTC\": {\n \"enabled\": true\n }\n },\n \"paymentCodes\": {\n \"BTC\": {\n \"BIP72b\": \"bitcoin:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"BCH\": {\n \"BIP72b\": \"bitcoincash:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"ETH\": {\n \"EIP681\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"GUSD\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"PAX\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"BUSD\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"USDC\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"XRP\": {\n \"BIP72b\": \"ripple:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"RIP681\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"DOGE\": {\n \"BIP72b\": \"dogecoin:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"DAI\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"WBTC\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n }\n },\n \"universalCodes\": {\n \"paymentString\": \"https://link.bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"verificationLink\": \"https://link.bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A?t=hv\"\n },\n \"token\": \"Svbfdow1xXc6chtQB3GVKqyRVhyLMqn3nhMhyTtf9T9vTCDKrVfdoA7n94nZUECZf\"\n }\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374167755cb9c00294ec5f0"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374164ec038610040ebede4"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"6374168a18b64e007e759b80"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"637416dbf2ff62001097f3b1"},{"name":"invoiceId","type":"string","enumValues":"","default":"","desc":"ID of the invoice to update","required":false,"in":"path","ref":"","_id":"63741e9fdc03a9009cd63c91"},{"name":"buyerEmail","type":"string","enumValues":"","default":"","desc":"Buyer email address (Updating an invoice will require EITHER an SMS or E-mail).","required":false,"in":"body","ref":"","_id":"63741ef75fa16900472494be"},{"name":"buyerSms","type":"string","enumValues":"","default":"","desc":"SMS to use to process any payment exception if necessary, includes country code i.e. “+12223334444\" (Updating an invoice will require EITHER an SMS or E-mail).","required":false,"in":"body","ref":"","_id":"63741f1ee81b0100967191cd"},{"name":"smsCode","type":"string","enumValues":"","default":"","desc":"Verification code in order to complete the SMS verification process (smsCode required only when verifying SMS).","required":false,"in":"body","ref":"","_id":"63741f1ee81b0100967191cc"},{"name":"token","type":"string","enumValues":"","default":"","desc":"Approved merchant facade token.","required":true,"in":"body","ref":"","_id":"63741f1ee81b0100967191cb"},{"name":"autoVerify","type":"string","enumValues":"","default":"","desc":"If provided alongside a valid SMS, will bypass the need to complete an SMS challenge (only available in the test environment).","required":false,"in":"body","ref":"","_id":"63741f1ee81b0100967191ca"},{"name":"status","type":"string","enumValues":"","default":"","desc":"<b>TEST ENVIRONMENT ONLY</b><br/>Can be forced to `confirmed` or `complete`.","required":false,"in":"body","ref":"","_id":"63fe7ea3d778be0064542a4e"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Update an Invoice","icon":"","type":"endpoint","slug":"update-an-invoice","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"636c55f800204c00917a96fd","createdAt":"2022-11-15T23:19:08.431Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]},{"_id":"63742d15282c63002a585780","api":{"method":"get","url":"/invoices/{invoiceId}","auth":"required","results":{"codes":[{"name":"pos facade","code":"{\n \"facade\": \"pos/invoice\",\n \"data\": {\n \"url\": \"https://bitpay.com/invoice?id=G3viJEJgE8Jk2oekSdgT2A\",\n \"posData\": \"\\\"{ \\\"ref\\\" : 711454, \\\"item\\\" : \\\"test_item\\\" }\\\"\",\n \"status\": \"confirmed\",\n \"price\": 20,\n \"currency\": \"USD\",\n \"orderId\": \"20210511_fghij\",\n \"invoiceTime\": 1620733980748,\n \"expirationTime\": 1620734880748,\n \"currentTime\": 1620734669770,\n \"guid\": \"payment#1234\",\n \"id\": \"G3viJEJgE8Jk2oekSdgT2A\",\n \"lowFeeDetected\": false,\n \"amountPaid\": 739100,\n \"displayAmountPaid\": \"0.007391\",\n \"exceptionStatus\": false,\n \"closeURL\": \"https://merchantwebsite.com/shop/cancel\",\n \"redirectURL\": \"https://merchantwebsite.com/shop/return\",\n \"autoRedirect\": false,\n \"refundAddressRequestPending\": false,\n \"buyerProvidedInfo\": {\n \"emailAddress\": \"Pa4HyqpK24krqxKYdBrDcu\",\n \"sms\": \"3TMbmA7pBnShz6u2QF2dLE\",\n \"smsVerified\": true,\n \"selectedWallet\": \"bitpay\",\n \"selectedTransactionCurrency\": \"BCH\"\n },\n \"paymentSubtotals\": {\n \"BTC\": 18000,\n \"BCH\": 739100,\n \"ETH\": 2505000000000000,\n \"GUSD\": 1000,\n \"PAX\": 10000000000000000000,\n \"BUSD\": 10000000000000000000,\n \"USDC\": 10000000,\n \"XRP\": 7015685,\n \"DOGE\": 1998865000,\n \"DAI\": 9990000000000000000,\n \"WBTC\": 18000\n },\n \"paymentTotals\": {\n \"BTC\": 29600,\n \"BCH\": 739100,\n \"ETH\": 2505000000000000,\n \"GUSD\": 1000,\n \"PAX\": 10000000000000000000,\n \"BUSD\": 10000000000000000000,\n \"USDC\": 10000000,\n \"XRP\": 7015685,\n \"DOGE\": 1998865000,\n \"DAI\": 9990000000000000000,\n \"WBTC\": 18000\n },\n \"paymentDisplayTotals\": {\n \"BTC\": \"0.000296\",\n \"BCH\": \"0.007391\",\n \"ETH\": \"0.002505\",\n \"GUSD\": \"10.00\",\n \"PAX\": \"10.00\",\n \"BUSD\": \"10.00\",\n \"USDC\": \"10.00\",\n \"XRP\": \"7.015685\",\n \"DOGE\": \"19.988650\",\n \"DAI\": \"9.99\",\n \"WBTC\": \"0.000180\"\n },\n \"paymentDisplaySubTotals\": {\n \"BTC\": \"0.000180\",\n \"BCH\": \"0.007391\",\n \"ETH\": \"0.002505\",\n \"GUSD\": \"10.00\",\n \"PAX\": \"10.00\",\n \"BUSD\": \"10.00\",\n \"USDC\": \"10.00\",\n \"XRP\": \"7.015685\",\n \"DOGE\": \"19.988650\",\n \"DAI\": \"9.99\",\n \"WBTC\": \"0.000180\"\n },\n \"exchangeRates\": {\n \"BTC\": {\n \"USD\": 55413.609335,\n \"EUR\": 45540.39841,\n \"BCH\": 40.84109737914668,\n \"ETH\": 13.870219975470258,\n \"GUSD\": 55413.609335,\n \"PAX\": 55413.609335,\n \"BUSD\": 55413.609335,\n \"USDC\": 55413.609335,\n \"XRP\": 38758.09372049268,\n \"DOGE\": 110606.00665668662,\n \"DAI\": 55359.96552840298,\n \"WBTC\": 0.9981333606461704\n },\n \"BCH\": {\n \"USD\": 1352.90925,\n \"EUR\": 1111.2150000000001,\n \"BTC\": 0.02440102556111244,\n \"ETH\": 0.33863791096704754,\n \"GUSD\": 1352.90925,\n \"PAX\": 1352.90925,\n \"BUSD\": 1352.90925,\n \"USDC\": 1352.90925,\n \"XRP\": 946.2690507998013,\n \"DOGE\": 2700.4176646706587,\n \"DAI\": 1351.599550036015,\n \"WBTC\": 0.024369173431532262\n },\n \"ETH\": {\n \"USD\": 3992.672665000001,\n \"EUR\": 3278.9696950000002,\n \"BTC\": 0.0720117094001833,\n \"BCH\": 2.9426910658087726,\n \"GUSD\": 3992.672665000001,\n \"PAX\": 3992.672665000001,\n \"BUSD\": 3992.672665000001,\n \"USDC\": 3992.672665000001,\n \"XRP\": 2792.6060619837313,\n \"DOGE\": 7969.406516966069,\n \"DAI\": 3988.807510522304,\n \"WBTC\": 0.07191770817497412\n },\n \"GUSD\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"PAX\": 1,\n \"BUSD\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"PAX\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"BUSD\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"BUSD\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"PAX\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"USDC\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"PAX\": 1,\n \"BUSD\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"XRP\": {\n \"USD\": 1.4253776249999999,\n \"EUR\": 1.17088545,\n \"BTC\": 0.00002570806272620483,\n \"BCH\": 0.0010505359077542177,\n \"ETH\": 0.0003567769983605121,\n \"GUSD\": 1.4253776249999999,\n \"PAX\": 1.4253776249999999,\n \"BUSD\": 1.4253776249999999,\n \"USDC\": 1.4253776249999999,\n \"DOGE\": 2.845065119760479,\n \"DAI\": 1.423997771159746,\n \"WBTC\": 0.00002567450444222371\n },\n \"DOGE\": {\n \"USD\": 0.5002839,\n \"EUR\": 0.4110702732486,\n \"BTC\": 0.000009023103531676658,\n \"BCH\": 0.0003687206757025671,\n \"ETH\": 0.00012522280765428083,\n \"GUSD\": 0.5002839,\n \"PAX\": 0.5002839,\n \"BUSD\": 0.5002839,\n \"USDC\": 0.5002839,\n \"XRP\": 0.3499149489763802,\n \"DAI\": 0.49979959419322684,\n \"WBTC\": 0.000009011325130716152\n },\n \"DAI\": {\n \"USD\": 1.000968,\n \"EUR\": 0.822469380432,\n \"BTC\": 0.000018053425057043255,\n \"BCH\": 0.0007377363079576361,\n \"ETH\": 0.00025054578676645436,\n \"GUSD\": 1.000968,\n \"PAX\": 1.000968,\n \"BUSD\": 1.000968,\n \"USDC\": 1.000968,\n \"XRP\": 0.7001098109433249,\n \"DOGE\": 1.9979401197604791,\n \"WBTC\": 0.000018029858833039973\n },\n \"WBTC\": {\n \"USD\": 55466.58,\n \"EUR\": 45575.44665492,\n \"BTC\": 1.000393364423732,\n \"BCH\": 40.88013797068123,\n \"ETH\": 13.883478717945511,\n \"GUSD\": 55466.58,\n \"PAX\": 55466.58,\n \"BUSD\": 55466.58,\n \"USDC\": 55466.58,\n \"XRP\": 38795.14313891434,\n \"DOGE\": 110711.73652694612,\n \"DAI\": 55412.88491451783\n }\n },\n \"supportedTransactionCurrencies\": {\n \"BTC\": {\n \"enabled\": true\n },\n \"BCH\": {\n \"enabled\": true\n },\n \"ETH\": {\n \"enabled\": true\n },\n \"GUSD\": {\n \"enabled\": true\n },\n \"PAX\": {\n \"enabled\": true\n },\n \"BUSD\": {\n \"enabled\": true\n },\n \"USDC\": {\n \"enabled\": true\n },\n \"XRP\": {\n \"enabled\": true\n },\n \"DOGE\": {\n \"enabled\": true\n },\n \"DAI\": {\n \"enabled\": true\n },\n \"WBTC\": {\n \"enabled\": true\n }\n },\n \"minerFees\": {\n \"BTC\": {\n \"satoshisPerByte\": 1,\n \"totalFee\": 100,\n \"fiatAmount\": 0.02\n },\n \"BCH\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"ETH\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"GUSD\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"PAX\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"BUSD\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"USDC\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"XRP\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"DOGE\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"DAI\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"WBTC\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n }\n },\n \"jsonPayProRequired\": false,\n \"itemizedDetails\": [\n {\n \"amount\": 5,\n \"description\": \"Item 1\",\n \"isFee\": false\n },\n {\n \"amount\": 15,\n \"description\": \"Item 2\",\n \"isFee\": false\n }\n ],\n \"transactionCurrency\": \"BCH\",\n \"universalCodes\": {\n \"paymentString\": \"https://link.bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"merchantName\": \"Test Merchant\",\n \"paymentCodes\": {\n \"BTC\": {\n \"BIP72b\": \"bitcoin:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"BCH\": {\n \"BIP72b\": \"bitcoincash:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"ETH\": {\n \"EIP681\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"GUSD\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"PAX\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"BUSD\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"USDC\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"XRP\": {\n \"BIP72b\": \"ripple:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"RIP681\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"DOGE\": {\n \"BIP72b\": \"dogecoin:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"DAI\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"WBTC\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n }\n },\n \"token\": \"8nPJSGgi7omxcbGGZ4KsSgdPFLVQGRDzRV9Yd4ZoNjDubzapTBtSLxgm3Vo6fTmGmF\"\n }\n}","language":"json","status":200},{"code":"{\n \"facade\": \"merchant/invoice\",\n \"data\": {\n \"url\": \"https://bitpay.com/invoice?id=G3viJEJgE8Jk2oekSdgT2A\",\n \"posData\": \"\\\"{ \\\"ref\\\" : 711454, \\\"item\\\" : \\\"test_item\\\" }\\\"\",\n \"status\": \"confirmed\",\n \"price\": 20,\n \"currency\": \"USD\",\n \"orderId\": \"20210511_fghij\",\n \"invoiceTime\": 1620733980748,\n \"expirationTime\": 1620734880748,\n \"currentTime\": 1620734253073,\n \"guid\": \"payment#1234\",\n \"id\": \"G3viJEJgE8Jk2oekSdgT2A\",\n \"lowFeeDetected\": false,\n \"amountPaid\": 739100,\n \"displayAmountPaid\": \"0.007391\",\n \"exceptionStatus\": false,\n \"targetConfirmations\": 6,\n \"transactions\": [\n {\n \"amount\": 739100,\n \"confirmations\": 1,\n \"receivedTime\": \"2021-05-11T11:54:32.978Z\",\n \"txid\": \"0638edcce08856726135e4f464e603706bc12313fd9a9cd046a177e4ffce98dd\",\n \"exRates\": {\n \"BCH\": 1,\n \"USD\": 1355.2800000000002,\n \"BTC\": 0.02446472581430398,\n \"EUR\": 1112.66,\n \"ETH\": 0.33972366494876377,\n \"GUSD\": 1355.2800000000002,\n \"PAX\": 1355.2800000000002,\n \"BUSD\": 1355.2800000000002,\n \"USDC\": 1355.2800000000002,\n \"XRP\": 948.9227925474189,\n \"DOGE\": 2725.466119299674,\n \"DAI\": 1353.985589776174,\n \"WBTC\": 0.024436520994387978\n },\n \"outputIndex\": 0\n }\n ],\n \"transactionSpeed\": \"medium\",\n \"buyer\": {\n \"email\": \"john@doe.com\"\n },\n \"redirectURL\": \"https://merchantwebsite.com/shop/return\",\n \"autoRedirect\": false,\n \"closeURL\": \"https://merchantwebsite.com/shop/cancel\",\n \"refundAddresses\": [],\n \"refundAddressRequestPending\": false,\n \"buyerProvidedEmail\": \"john@doe.com\",\n \"buyerProvidedInfo\": {\n \"emailAddress\": \"john@doe.com\",\n \"sms\": \"+12223334444\",\n \"smsVerified\": true,\n \"selectedWallet\": \"bitpay\",\n \"selectedTransactionCurrency\": \"BCH\",\n \"emailAddress\": \"john@doe.com\"\n },\n \"paymentSubtotals\": {\n \"BTC\": 18000,\n \"BCH\": 739100,\n \"ETH\": 2505000000000000,\n \"GUSD\": 1000,\n \"PAX\": 10000000000000000000,\n \"BUSD\": 10000000000000000000,\n \"USDC\": 10000000,\n \"XRP\": 7015685,\n \"DOGE\": 1998865000,\n \"DAI\": 9990000000000000000,\n \"WBTC\": 18000\n },\n \"paymentTotals\": {\n \"BTC\": 29600,\n \"BCH\": 739100,\n \"ETH\": 2505000000000000,\n \"GUSD\": 1000,\n \"PAX\": 10000000000000000000,\n \"BUSD\": 10000000000000000000,\n \"USDC\": 10000000,\n \"XRP\": 7015685,\n \"DOGE\": 1998865000,\n \"DAI\": 9990000000000000000,\n \"WBTC\": 18000\n },\n \"paymentDisplayTotals\": {\n \"BTC\": \"0.000296\",\n \"BCH\": \"0.007391\",\n \"ETH\": \"0.002505\",\n \"GUSD\": \"10.00\",\n \"PAX\": \"10.00\",\n \"BUSD\": \"10.00\",\n \"USDC\": \"10.00\",\n \"XRP\": \"7.015685\",\n \"DOGE\": \"19.988650\",\n \"DAI\": \"9.99\",\n \"WBTC\": \"0.000180\"\n },\n \"paymentDisplaySubTotals\": {\n \"BTC\": \"0.000180\",\n \"BCH\": \"0.007391\",\n \"ETH\": \"0.002505\",\n \"GUSD\": \"10.00\",\n \"PAX\": \"10.00\",\n \"BUSD\": \"10.00\",\n \"USDC\": \"10.00\",\n \"XRP\": \"7.015685\",\n \"DOGE\": \"19.988650\",\n \"DAI\": \"9.99\",\n \"WBTC\": \"0.000180\"\n },\n \"exchangeRates\": {\n \"BTC\": {\n \"USD\": 55413.609335,\n \"EUR\": 45540.39841,\n \"BCH\": 40.84109737914668,\n \"ETH\": 13.870219975470258,\n \"GUSD\": 55413.609335,\n \"PAX\": 55413.609335,\n \"BUSD\": 55413.609335,\n \"USDC\": 55413.609335,\n \"XRP\": 38758.09372049268,\n \"DOGE\": 110606.00665668662,\n \"DAI\": 55359.96552840298,\n \"WBTC\": 0.9981333606461704\n },\n \"BCH\": {\n \"USD\": 1352.90925,\n \"EUR\": 1111.2150000000001,\n \"BTC\": 0.02440102556111244,\n \"ETH\": 0.33863791096704754,\n \"GUSD\": 1352.90925,\n \"PAX\": 1352.90925,\n \"BUSD\": 1352.90925,\n \"USDC\": 1352.90925,\n \"XRP\": 946.2690507998013,\n \"DOGE\": 2700.4176646706587,\n \"DAI\": 1351.599550036015,\n \"WBTC\": 0.024369173431532262\n },\n \"ETH\": {\n \"USD\": 3992.672665000001,\n \"EUR\": 3278.9696950000002,\n \"BTC\": 0.0720117094001833,\n \"BCH\": 2.9426910658087726,\n \"GUSD\": 3992.672665000001,\n \"PAX\": 3992.672665000001,\n \"BUSD\": 3992.672665000001,\n \"USDC\": 3992.672665000001,\n \"XRP\": 2792.6060619837313,\n \"DOGE\": 7969.406516966069,\n \"DAI\": 3988.807510522304,\n \"WBTC\": 0.07191770817497412\n },\n \"GUSD\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"PAX\": 1,\n \"BUSD\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"PAX\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"BUSD\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"BUSD\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"PAX\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"USDC\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"PAX\": 1,\n \"BUSD\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"XRP\": {\n \"USD\": 1.4253776249999999,\n \"EUR\": 1.17088545,\n \"BTC\": 0.00002570806272620483,\n \"BCH\": 0.0010505359077542177,\n \"ETH\": 0.0003567769983605121,\n \"GUSD\": 1.4253776249999999,\n \"PAX\": 1.4253776249999999,\n \"BUSD\": 1.4253776249999999,\n \"USDC\": 1.4253776249999999,\n \"DOGE\": 2.845065119760479,\n \"DAI\": 1.423997771159746,\n \"WBTC\": 0.00002567450444222371\n },\n \"DOGE\": {\n \"USD\": 0.5002839,\n \"EUR\": 0.4110702732486,\n \"BTC\": 0.000009023103531676658,\n \"BCH\": 0.0003687206757025671,\n \"ETH\": 0.00012522280765428083,\n \"GUSD\": 0.5002839,\n \"PAX\": 0.5002839,\n \"BUSD\": 0.5002839,\n \"USDC\": 0.5002839,\n \"XRP\": 0.3499149489763802,\n \"DAI\": 0.49979959419322684,\n \"WBTC\": 0.000009011325130716152\n },\n \"DAI\": {\n \"USD\": 1.000968,\n \"EUR\": 0.822469380432,\n \"BTC\": 0.000018053425057043255,\n \"BCH\": 0.0007377363079576361,\n \"ETH\": 0.00025054578676645436,\n \"GUSD\": 1.000968,\n \"PAX\": 1.000968,\n \"BUSD\": 1.000968,\n \"USDC\": 1.000968,\n \"XRP\": 0.7001098109433249,\n \"DOGE\": 1.9979401197604791,\n \"WBTC\": 0.000018029858833039973\n },\n \"WBTC\": {\n \"USD\": 55466.58,\n \"EUR\": 45575.44665492,\n \"BTC\": 1.000393364423732,\n \"BCH\": 40.88013797068123,\n \"ETH\": 13.883478717945511,\n \"GUSD\": 55466.58,\n \"PAX\": 55466.58,\n \"BUSD\": 55466.58,\n \"USDC\": 55466.58,\n \"XRP\": 38795.14313891434,\n \"DOGE\": 110711.73652694612,\n \"DAI\": 55412.88491451783\n }\n },\n \"minerFees\": {\n \"BTC\": {\n \"satoshisPerByte\": 1,\n \"totalFee\": 100,\n \"fiatAmount\": 0.02\n },\n \"BCH\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"ETH\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"GUSD\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"PAX\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"BUSD\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"USDC\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"XRP\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"DOGE\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"DAI\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"WBTC\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n }\n },\n \"shopper\": {\n \"user\": \"FeFc5a7hUwmrEnYwVPmrkp\"\n },\n \"jsonPayProRequired\": false,\n \"merchantName\": \"Test Merchant\",\n \"bitpayIdRequired\": true,\n \"isCancelled\": false,\n \"itemizedDetails\": [\n {\n \"amount\": 5,\n \"description\": \"Item 1\",\n \"isFee\": false\n },\n {\n \"amount\": 15,\n \"description\": \"Item 2\",\n \"isFee\": false\n }\n ],\n \"transactionCurrency\": \"BCH\",\n \"supportedTransactionCurrencies\": {\n \"BTC\": {\n \"enabled\": true\n },\n \"BCH\": {\n \"enabled\": true\n },\n \"ETH\": {\n \"enabled\": true\n },\n \"GUSD\": {\n \"enabled\": true\n },\n \"PAX\": {\n \"enabled\": true\n },\n \"BUSD\": {\n \"enabled\": true\n },\n \"USDC\": {\n \"enabled\": true\n },\n \"XRP\": {\n \"enabled\": true\n },\n \"DOGE\": {\n \"enabled\": true\n },\n \"DAI\": {\n \"enabled\": true\n },\n \"WBTC\": {\n \"enabled\": true\n }\n },\n \"paymentCodes\": {\n \"BTC\": {\n \"BIP72b\": \"bitcoin:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"BCH\": {\n \"BIP72b\": \"bitcoincash:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"ETH\": {\n \"EIP681\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"GUSD\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"PAX\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"BUSD\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"USDC\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"XRP\": {\n \"BIP72b\": \"ripple:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"RIP681\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"DOGE\": {\n \"BIP72b\": \"dogecoin:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"DAI\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"WBTC\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n }\n },\n \"universalCodes\": {\n \"paymentString\": \"https://link.bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"verificationLink\": \"https://link.bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A?t=hv\"\n },\n \"token\": \"Svbfdow1xXc6chtQB3GVKqyRVhyLMqn3nhMhyTtf9T9vTCDKrVfdoA7n94nZUECZf\"\n }\n}","language":"json","status":200,"name":"merchant facade"}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374167755cb9c00294ec5f0"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374164ec038610040ebede4"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":false,"in":"header","ref":"","_id":"6374168a18b64e007e759b80"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":false,"in":"header","ref":"","_id":"637416dbf2ff62001097f3b1"},{"name":"invoiceId","type":"string","enumValues":"","default":"","desc":"ID of the invoice to retrieve","required":false,"in":"path","ref":"","_id":"63741e9fdc03a9009cd63c91"},{"name":"token","type":"string","enumValues":"","default":"","desc":"When fetching an invoice via the merchant or the pos facade, pass the API token as a URL parameter - the same token used to create the invoice in the first place.","required":false,"in":"query","ref":"","_id":"63742d630b130c000fe8596b"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Retrieve an Invoice","icon":"","type":"endpoint","slug":"retrieve-an-invoice","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"636c55f800204c00917a96fd","createdAt":"2022-11-16T00:21:41.604Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]},{"_id":"63742dd41507cb009b166853","api":{"method":"get","url":"/invoices/guid/{guid}","auth":"required","results":{"codes":[{"name":"pos facade","code":"{\n \"facade\": \"pos/invoice\",\n \"data\": {\n \"url\": \"https://bitpay.com/invoice?id=G3viJEJgE8Jk2oekSdgT2A\",\n \"posData\": \"\\\"{ \\\"ref\\\" : 711454, \\\"item\\\" : \\\"test_item\\\" }\\\"\",\n \"status\": \"confirmed\",\n \"price\": 20,\n \"currency\": \"USD\",\n \"orderId\": \"20210511_fghij\",\n \"invoiceTime\": 1620733980748,\n \"expirationTime\": 1620734880748,\n \"currentTime\": 1620734669770,\n \"guid\": \"payment#1234\",\n \"id\": \"G3viJEJgE8Jk2oekSdgT2A\",\n \"lowFeeDetected\": false,\n \"amountPaid\": 739100,\n \"displayAmountPaid\": \"0.007391\",\n \"exceptionStatus\": false,\n \"closeURL\": \"https://merchantwebsite.com/shop/cancel\",\n \"redirectURL\": \"https://merchantwebsite.com/shop/return\",\n \"autoRedirect\": false,\n \"refundAddressRequestPending\": false,\n \"buyerProvidedInfo\": {\n \"emailAddress\": \"Pa4HyqpK24krqxKYdBrDcu\",\n \"sms\": \"3TMbmA7pBnShz6u2QF2dLE\",\n \"smsVerified\": true,\n \"selectedWallet\": \"bitpay\",\n \"selectedTransactionCurrency\": \"BCH\"\n },\n \"paymentSubtotals\": {\n \"BTC\": 18000,\n \"BCH\": 739100,\n \"ETH\": 2505000000000000,\n \"GUSD\": 1000,\n \"PAX\": 10000000000000000000,\n \"BUSD\": 10000000000000000000,\n \"USDC\": 10000000,\n \"XRP\": 7015685,\n \"DOGE\": 1998865000,\n \"DAI\": 9990000000000000000,\n \"WBTC\": 18000\n },\n \"paymentTotals\": {\n \"BTC\": 29600,\n \"BCH\": 739100,\n \"ETH\": 2505000000000000,\n \"GUSD\": 1000,\n \"PAX\": 10000000000000000000,\n \"BUSD\": 10000000000000000000,\n \"USDC\": 10000000,\n \"XRP\": 7015685,\n \"DOGE\": 1998865000,\n \"DAI\": 9990000000000000000,\n \"WBTC\": 18000\n },\n \"paymentDisplayTotals\": {\n \"BTC\": \"0.000296\",\n \"BCH\": \"0.007391\",\n \"ETH\": \"0.002505\",\n \"GUSD\": \"10.00\",\n \"PAX\": \"10.00\",\n \"BUSD\": \"10.00\",\n \"USDC\": \"10.00\",\n \"XRP\": \"7.015685\",\n \"DOGE\": \"19.988650\",\n \"DAI\": \"9.99\",\n \"WBTC\": \"0.000180\"\n },\n \"paymentDisplaySubTotals\": {\n \"BTC\": \"0.000180\",\n \"BCH\": \"0.007391\",\n \"ETH\": \"0.002505\",\n \"GUSD\": \"10.00\",\n \"PAX\": \"10.00\",\n \"BUSD\": \"10.00\",\n \"USDC\": \"10.00\",\n \"XRP\": \"7.015685\",\n \"DOGE\": \"19.988650\",\n \"DAI\": \"9.99\",\n \"WBTC\": \"0.000180\"\n },\n \"exchangeRates\": {\n \"BTC\": {\n \"USD\": 55413.609335,\n \"EUR\": 45540.39841,\n \"BCH\": 40.84109737914668,\n \"ETH\": 13.870219975470258,\n \"GUSD\": 55413.609335,\n \"PAX\": 55413.609335,\n \"BUSD\": 55413.609335,\n \"USDC\": 55413.609335,\n \"XRP\": 38758.09372049268,\n \"DOGE\": 110606.00665668662,\n \"DAI\": 55359.96552840298,\n \"WBTC\": 0.9981333606461704\n },\n \"BCH\": {\n \"USD\": 1352.90925,\n \"EUR\": 1111.2150000000001,\n \"BTC\": 0.02440102556111244,\n \"ETH\": 0.33863791096704754,\n \"GUSD\": 1352.90925,\n \"PAX\": 1352.90925,\n \"BUSD\": 1352.90925,\n \"USDC\": 1352.90925,\n \"XRP\": 946.2690507998013,\n \"DOGE\": 2700.4176646706587,\n \"DAI\": 1351.599550036015,\n \"WBTC\": 0.024369173431532262\n },\n \"ETH\": {\n \"USD\": 3992.672665000001,\n \"EUR\": 3278.9696950000002,\n \"BTC\": 0.0720117094001833,\n \"BCH\": 2.9426910658087726,\n \"GUSD\": 3992.672665000001,\n \"PAX\": 3992.672665000001,\n \"BUSD\": 3992.672665000001,\n \"USDC\": 3992.672665000001,\n \"XRP\": 2792.6060619837313,\n \"DOGE\": 7969.406516966069,\n \"DAI\": 3988.807510522304,\n \"WBTC\": 0.07191770817497412\n },\n \"GUSD\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"PAX\": 1,\n \"BUSD\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"PAX\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"BUSD\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"BUSD\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"PAX\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"USDC\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"PAX\": 1,\n \"BUSD\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"XRP\": {\n \"USD\": 1.4253776249999999,\n \"EUR\": 1.17088545,\n \"BTC\": 0.00002570806272620483,\n \"BCH\": 0.0010505359077542177,\n \"ETH\": 0.0003567769983605121,\n \"GUSD\": 1.4253776249999999,\n \"PAX\": 1.4253776249999999,\n \"BUSD\": 1.4253776249999999,\n \"USDC\": 1.4253776249999999,\n \"DOGE\": 2.845065119760479,\n \"DAI\": 1.423997771159746,\n \"WBTC\": 0.00002567450444222371\n },\n \"DOGE\": {\n \"USD\": 0.5002839,\n \"EUR\": 0.4110702732486,\n \"BTC\": 0.000009023103531676658,\n \"BCH\": 0.0003687206757025671,\n \"ETH\": 0.00012522280765428083,\n \"GUSD\": 0.5002839,\n \"PAX\": 0.5002839,\n \"BUSD\": 0.5002839,\n \"USDC\": 0.5002839,\n \"XRP\": 0.3499149489763802,\n \"DAI\": 0.49979959419322684,\n \"WBTC\": 0.000009011325130716152\n },\n \"DAI\": {\n \"USD\": 1.000968,\n \"EUR\": 0.822469380432,\n \"BTC\": 0.000018053425057043255,\n \"BCH\": 0.0007377363079576361,\n \"ETH\": 0.00025054578676645436,\n \"GUSD\": 1.000968,\n \"PAX\": 1.000968,\n \"BUSD\": 1.000968,\n \"USDC\": 1.000968,\n \"XRP\": 0.7001098109433249,\n \"DOGE\": 1.9979401197604791,\n \"WBTC\": 0.000018029858833039973\n },\n \"WBTC\": {\n \"USD\": 55466.58,\n \"EUR\": 45575.44665492,\n \"BTC\": 1.000393364423732,\n \"BCH\": 40.88013797068123,\n \"ETH\": 13.883478717945511,\n \"GUSD\": 55466.58,\n \"PAX\": 55466.58,\n \"BUSD\": 55466.58,\n \"USDC\": 55466.58,\n \"XRP\": 38795.14313891434,\n \"DOGE\": 110711.73652694612,\n \"DAI\": 55412.88491451783\n }\n },\n \"supportedTransactionCurrencies\": {\n \"BTC\": {\n \"enabled\": true\n },\n \"BCH\": {\n \"enabled\": true\n },\n \"ETH\": {\n \"enabled\": true\n },\n \"GUSD\": {\n \"enabled\": true\n },\n \"PAX\": {\n \"enabled\": true\n },\n \"BUSD\": {\n \"enabled\": true\n },\n \"USDC\": {\n \"enabled\": true\n },\n \"XRP\": {\n \"enabled\": true\n },\n \"DOGE\": {\n \"enabled\": true\n },\n \"DAI\": {\n \"enabled\": true\n },\n \"WBTC\": {\n \"enabled\": true\n }\n },\n \"minerFees\": {\n \"BTC\": {\n \"satoshisPerByte\": 1,\n \"totalFee\": 100,\n \"fiatAmount\": 0.02\n },\n \"BCH\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"ETH\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"GUSD\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"PAX\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"BUSD\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"USDC\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"XRP\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"DOGE\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"DAI\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"WBTC\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n }\n },\n \"jsonPayProRequired\": false,\n \"itemizedDetails\": [\n {\n \"amount\": 5,\n \"description\": \"Item 1\",\n \"isFee\": false\n },\n {\n \"amount\": 15,\n \"description\": \"Item 2\",\n \"isFee\": false\n }\n ],\n \"transactionCurrency\": \"BCH\",\n \"universalCodes\": {\n \"paymentString\": \"https://link.bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"merchantName\": \"Test Merchant\",\n \"paymentCodes\": {\n \"BTC\": {\n \"BIP72b\": \"bitcoin:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"BCH\": {\n \"BIP72b\": \"bitcoincash:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"ETH\": {\n \"EIP681\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"GUSD\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"PAX\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"BUSD\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"USDC\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"XRP\": {\n \"BIP72b\": \"ripple:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"RIP681\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"DOGE\": {\n \"BIP72b\": \"dogecoin:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"DAI\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"WBTC\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n }\n },\n \"token\": \"8nPJSGgi7omxcbGGZ4KsSgdPFLVQGRDzRV9Yd4ZoNjDubzapTBtSLxgm3Vo6fTmGmF\"\n }\n}","language":"json","status":200},{"code":"{\n \"facade\": \"merchant/invoice\",\n \"data\": {\n \"url\": \"https://bitpay.com/invoice?id=G3viJEJgE8Jk2oekSdgT2A\",\n \"posData\": \"\\\"{ \\\"ref\\\" : 711454, \\\"item\\\" : \\\"test_item\\\" }\\\"\",\n \"status\": \"confirmed\",\n \"price\": 20,\n \"currency\": \"USD\",\n \"orderId\": \"20210511_fghij\",\n \"invoiceTime\": 1620733980748,\n \"expirationTime\": 1620734880748,\n \"currentTime\": 1620734253073,\n \"guid\": \"payment#1234\",\n \"id\": \"G3viJEJgE8Jk2oekSdgT2A\",\n \"lowFeeDetected\": false,\n \"amountPaid\": 739100,\n \"displayAmountPaid\": \"0.007391\",\n \"exceptionStatus\": false,\n \"targetConfirmations\": 6,\n \"transactions\": [\n {\n \"amount\": 739100,\n \"confirmations\": 1,\n \"receivedTime\": \"2021-05-11T11:54:32.978Z\",\n \"txid\": \"0638edcce08856726135e4f464e603706bc12313fd9a9cd046a177e4ffce98dd\",\n \"exRates\": {\n \"BCH\": 1,\n \"USD\": 1355.2800000000002,\n \"BTC\": 0.02446472581430398,\n \"EUR\": 1112.66,\n \"ETH\": 0.33972366494876377,\n \"GUSD\": 1355.2800000000002,\n \"PAX\": 1355.2800000000002,\n \"BUSD\": 1355.2800000000002,\n \"USDC\": 1355.2800000000002,\n \"XRP\": 948.9227925474189,\n \"DOGE\": 2725.466119299674,\n \"DAI\": 1353.985589776174,\n \"WBTC\": 0.024436520994387978\n },\n \"outputIndex\": 0\n }\n ],\n \"transactionSpeed\": \"medium\",\n \"buyer\": {\n \"email\": \"john@doe.com\"\n },\n \"redirectURL\": \"https://merchantwebsite.com/shop/return\",\n \"autoRedirect\": false,\n \"closeURL\": \"https://merchantwebsite.com/shop/cancel\",\n \"refundAddresses\": [],\n \"refundAddressRequestPending\": false,\n \"buyerProvidedEmail\": \"john@doe.com\",\n \"buyerProvidedInfo\": {\n \"emailAddress\": \"john@doe.com\",\n \"sms\": \"+12223334444\",\n \"smsVerified\": true,\n \"selectedWallet\": \"bitpay\",\n \"selectedTransactionCurrency\": \"BCH\",\n \"emailAddress\": \"john@doe.com\"\n },\n \"paymentSubtotals\": {\n \"BTC\": 18000,\n \"BCH\": 739100,\n \"ETH\": 2505000000000000,\n \"GUSD\": 1000,\n \"PAX\": 10000000000000000000,\n \"BUSD\": 10000000000000000000,\n \"USDC\": 10000000,\n \"XRP\": 7015685,\n \"DOGE\": 1998865000,\n \"DAI\": 9990000000000000000,\n \"WBTC\": 18000\n },\n \"paymentTotals\": {\n \"BTC\": 29600,\n \"BCH\": 739100,\n \"ETH\": 2505000000000000,\n \"GUSD\": 1000,\n \"PAX\": 10000000000000000000,\n \"BUSD\": 10000000000000000000,\n \"USDC\": 10000000,\n \"XRP\": 7015685,\n \"DOGE\": 1998865000,\n \"DAI\": 9990000000000000000,\n \"WBTC\": 18000\n },\n \"paymentDisplayTotals\": {\n \"BTC\": \"0.000296\",\n \"BCH\": \"0.007391\",\n \"ETH\": \"0.002505\",\n \"GUSD\": \"10.00\",\n \"PAX\": \"10.00\",\n \"BUSD\": \"10.00\",\n \"USDC\": \"10.00\",\n \"XRP\": \"7.015685\",\n \"DOGE\": \"19.988650\",\n \"DAI\": \"9.99\",\n \"WBTC\": \"0.000180\"\n },\n \"paymentDisplaySubTotals\": {\n \"BTC\": \"0.000180\",\n \"BCH\": \"0.007391\",\n \"ETH\": \"0.002505\",\n \"GUSD\": \"10.00\",\n \"PAX\": \"10.00\",\n \"BUSD\": \"10.00\",\n \"USDC\": \"10.00\",\n \"XRP\": \"7.015685\",\n \"DOGE\": \"19.988650\",\n \"DAI\": \"9.99\",\n \"WBTC\": \"0.000180\"\n },\n \"exchangeRates\": {\n \"BTC\": {\n \"USD\": 55413.609335,\n \"EUR\": 45540.39841,\n \"BCH\": 40.84109737914668,\n \"ETH\": 13.870219975470258,\n \"GUSD\": 55413.609335,\n \"PAX\": 55413.609335,\n \"BUSD\": 55413.609335,\n \"USDC\": 55413.609335,\n \"XRP\": 38758.09372049268,\n \"DOGE\": 110606.00665668662,\n \"DAI\": 55359.96552840298,\n \"WBTC\": 0.9981333606461704\n },\n \"BCH\": {\n \"USD\": 1352.90925,\n \"EUR\": 1111.2150000000001,\n \"BTC\": 0.02440102556111244,\n \"ETH\": 0.33863791096704754,\n \"GUSD\": 1352.90925,\n \"PAX\": 1352.90925,\n \"BUSD\": 1352.90925,\n \"USDC\": 1352.90925,\n \"XRP\": 946.2690507998013,\n \"DOGE\": 2700.4176646706587,\n \"DAI\": 1351.599550036015,\n \"WBTC\": 0.024369173431532262\n },\n \"ETH\": {\n \"USD\": 3992.672665000001,\n \"EUR\": 3278.9696950000002,\n \"BTC\": 0.0720117094001833,\n \"BCH\": 2.9426910658087726,\n \"GUSD\": 3992.672665000001,\n \"PAX\": 3992.672665000001,\n \"BUSD\": 3992.672665000001,\n \"USDC\": 3992.672665000001,\n \"XRP\": 2792.6060619837313,\n \"DOGE\": 7969.406516966069,\n \"DAI\": 3988.807510522304,\n \"WBTC\": 0.07191770817497412\n },\n \"GUSD\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"PAX\": 1,\n \"BUSD\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"PAX\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"BUSD\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"BUSD\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"PAX\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"USDC\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"PAX\": 1,\n \"BUSD\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"XRP\": {\n \"USD\": 1.4253776249999999,\n \"EUR\": 1.17088545,\n \"BTC\": 0.00002570806272620483,\n \"BCH\": 0.0010505359077542177,\n \"ETH\": 0.0003567769983605121,\n \"GUSD\": 1.4253776249999999,\n \"PAX\": 1.4253776249999999,\n \"BUSD\": 1.4253776249999999,\n \"USDC\": 1.4253776249999999,\n \"DOGE\": 2.845065119760479,\n \"DAI\": 1.423997771159746,\n \"WBTC\": 0.00002567450444222371\n },\n \"DOGE\": {\n \"USD\": 0.5002839,\n \"EUR\": 0.4110702732486,\n \"BTC\": 0.000009023103531676658,\n \"BCH\": 0.0003687206757025671,\n \"ETH\": 0.00012522280765428083,\n \"GUSD\": 0.5002839,\n \"PAX\": 0.5002839,\n \"BUSD\": 0.5002839,\n \"USDC\": 0.5002839,\n \"XRP\": 0.3499149489763802,\n \"DAI\": 0.49979959419322684,\n \"WBTC\": 0.000009011325130716152\n },\n \"DAI\": {\n \"USD\": 1.000968,\n \"EUR\": 0.822469380432,\n \"BTC\": 0.000018053425057043255,\n \"BCH\": 0.0007377363079576361,\n \"ETH\": 0.00025054578676645436,\n \"GUSD\": 1.000968,\n \"PAX\": 1.000968,\n \"BUSD\": 1.000968,\n \"USDC\": 1.000968,\n \"XRP\": 0.7001098109433249,\n \"DOGE\": 1.9979401197604791,\n \"WBTC\": 0.000018029858833039973\n },\n \"WBTC\": {\n \"USD\": 55466.58,\n \"EUR\": 45575.44665492,\n \"BTC\": 1.000393364423732,\n \"BCH\": 40.88013797068123,\n \"ETH\": 13.883478717945511,\n \"GUSD\": 55466.58,\n \"PAX\": 55466.58,\n \"BUSD\": 55466.58,\n \"USDC\": 55466.58,\n \"XRP\": 38795.14313891434,\n \"DOGE\": 110711.73652694612,\n \"DAI\": 55412.88491451783\n }\n },\n \"minerFees\": {\n \"BTC\": {\n \"satoshisPerByte\": 1,\n \"totalFee\": 100,\n \"fiatAmount\": 0.02\n },\n \"BCH\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"ETH\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"GUSD\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"PAX\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"BUSD\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"USDC\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"XRP\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"DOGE\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"DAI\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"WBTC\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n }\n },\n \"shopper\": {\n \"user\": \"FeFc5a7hUwmrEnYwVPmrkp\"\n },\n \"jsonPayProRequired\": false,\n \"merchantName\": \"Test Merchant\",\n \"bitpayIdRequired\": true,\n \"isCancelled\": false,\n \"itemizedDetails\": [\n {\n \"amount\": 5,\n \"description\": \"Item 1\",\n \"isFee\": false\n },\n {\n \"amount\": 15,\n \"description\": \"Item 2\",\n \"isFee\": false\n }\n ],\n \"transactionCurrency\": \"BCH\",\n \"supportedTransactionCurrencies\": {\n \"BTC\": {\n \"enabled\": true\n },\n \"BCH\": {\n \"enabled\": true\n },\n \"ETH\": {\n \"enabled\": true\n },\n \"GUSD\": {\n \"enabled\": true\n },\n \"PAX\": {\n \"enabled\": true\n },\n \"BUSD\": {\n \"enabled\": true\n },\n \"USDC\": {\n \"enabled\": true\n },\n \"XRP\": {\n \"enabled\": true\n },\n \"DOGE\": {\n \"enabled\": true\n },\n \"DAI\": {\n \"enabled\": true\n },\n \"WBTC\": {\n \"enabled\": true\n }\n },\n \"paymentCodes\": {\n \"BTC\": {\n \"BIP72b\": \"bitcoin:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"BCH\": {\n \"BIP72b\": \"bitcoincash:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"ETH\": {\n \"EIP681\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"GUSD\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"PAX\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"BUSD\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"USDC\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"XRP\": {\n \"BIP72b\": \"ripple:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"RIP681\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"DOGE\": {\n \"BIP72b\": \"dogecoin:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"DAI\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"WBTC\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n }\n },\n \"universalCodes\": {\n \"paymentString\": \"https://link.bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"verificationLink\": \"https://link.bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A?t=hv\"\n },\n \"token\": \"Svbfdow1xXc6chtQB3GVKqyRVhyLMqn3nhMhyTtf9T9vTCDKrVfdoA7n94nZUECZf\"\n }\n}","language":"json","status":200,"name":"merchant facade"}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374167755cb9c00294ec5f0"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374164ec038610040ebede4"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"6374168a18b64e007e759b80"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"637416dbf2ff62001097f3b1"},{"name":"guid","type":"string","enumValues":"","default":"","desc":"The guid of the invoice being retrieved","required":false,"in":"path","ref":"","_id":"63741e9fdc03a9009cd63c91"},{"name":"token","type":"string","enumValues":"","default":"","desc":"When fetching an invoice via the merchant or the pos facade, pass the API token as a URL parameter - the same token used to create the invoice in the first place.","required":true,"in":"query","ref":"","_id":"63742d630b130c000fe8596b"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Retrieve an Invoice by GUID","icon":"","type":"endpoint","slug":"retrieve-an-invoice-by-guid","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"636c55f800204c00917a96fd","createdAt":"2022-11-16T00:24:52.955Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]},{"_id":"63742e70181abe00940e3e81","api":{"method":"get","url":"/invoices","auth":"required","results":{"codes":[{"name":"","code":"{\n \"facade\": \"merchant/invoice\",\n \"data\": [\n {\n \"url\": \"https://bitpay.com/invoice?id=KSnNNfoMDsbRzd1U9ypmVH\",\n \"posData\": \"\\\"{ \\\"ref\\\" : 711454, \\\"item\\\" : \\\"test_item\\\" }\\\"\",\n \"status\": \"confirmed\",\n \"price\": 20,\n \"currency\": \"USD\",\n \"orderId\": \"20210511_abcde\",\n \"invoiceTime\": 1620734545366,\n \"expirationTime\": 1620735445366,\n \"currentTime\": 1620744196444,\n \"guid\": \"payment#1234\",\n \"id\": \"KSnNNfoMDsbRzd1U9ypmVH\",\n \"lowFeeDetected\": false,\n \"amountPaid\": 744500,\n \"displayAmountPaid\": \"0.007445\",\n \"exceptionStatus\": false,\n \"targetConfirmations\": 6,\n \"transactions\": [\n {\n \"amount\": 744500,\n \"confirmations\": 6,\n \"receivedTime\": \"2021-05-11T12:03:01.526Z\",\n \"txid\": \"f35a1dff9ecf0e1cd87d6922eaa1d5e8faaca65efd84b2e5869e8ed7fcfb6fe4\",\n \"exRates\": {\n \"BCH\": 1,\n \"USD\": 1346.5200000000002,\n \"BTC\": 0.0244377406759562,\n \"EUR\": 1107.25,\n \"ETH\": 0.34117098582128125,\n \"GUSD\": 1346.5200000000002,\n \"PAX\": 1346.5200000000002,\n \"BUSD\": 1346.5200000000002,\n \"USDC\": 1346.5200000000002,\n \"XRP\": 951.2882646753377,\n \"DOGE\": 2779.8244514805524,\n \"DAI\": 1345.2003584483623,\n \"WBTC\": 0.024409662928680975\n },\n \"outputIndex\": 1\n }\n ],\n \"transactionSpeed\": \"medium\",\n \"buyer\": {\n \"email\": \"john@doe.com\"\n },\n \"redirectURL\": \"https://merchantwebsite.com/shop/return\",\n \"autoRedirect\": false,\n \"closeURL\": \"https://merchantwebsite.com/shop/cancel\",\n \"refundAddresses\": [],\n \"refundAddressRequestPending\": false,\n \"buyerProvidedEmail\": \"john@doe.com\",\n \"buyerProvidedInfo\": {\n \"emailAddress\": \"john@doe.com\",\n \"sms\": \"+12223334444\",\n \"smsVerified\": true,\n \"selectedWallet\": \"bitpay\",\n \"selectedTransactionCurrency\": \"BCH\",\n \"emailAddress\": \"john@doe.com\"\n },\n \"paymentSubtotals\": {\n \"BTC\": 18000,\n \"BCH\": 739100,\n \"ETH\": 2505000000000000,\n \"GUSD\": 1000,\n \"PAX\": 10000000000000000000,\n \"BUSD\": 10000000000000000000,\n \"USDC\": 10000000,\n \"XRP\": 7015685,\n \"DOGE\": 1998865000,\n \"DAI\": 9990000000000000000,\n \"WBTC\": 18000\n },\n \"paymentTotals\": {\n \"BTC\": 29600,\n \"BCH\": 739100,\n \"ETH\": 2505000000000000,\n \"GUSD\": 1000,\n \"PAX\": 10000000000000000000,\n \"BUSD\": 10000000000000000000,\n \"USDC\": 10000000,\n \"XRP\": 7015685,\n \"DOGE\": 1998865000,\n \"DAI\": 9990000000000000000,\n \"WBTC\": 18000\n },\n \"paymentDisplayTotals\": {\n \"BTC\": \"0.000296\",\n \"BCH\": \"0.007391\",\n \"ETH\": \"0.002505\",\n \"GUSD\": \"10.00\",\n \"PAX\": \"10.00\",\n \"BUSD\": \"10.00\",\n \"USDC\": \"10.00\",\n \"XRP\": \"7.015685\",\n \"DOGE\": \"19.988650\",\n \"DAI\": \"9.99\",\n \"WBTC\": \"0.000180\"\n },\n \"paymentDisplaySubTotals\": {\n \"BTC\": \"0.000180\",\n \"BCH\": \"0.007391\",\n \"ETH\": \"0.002505\",\n \"GUSD\": \"10.00\",\n \"PAX\": \"10.00\",\n \"BUSD\": \"10.00\",\n \"USDC\": \"10.00\",\n \"XRP\": \"7.015685\",\n \"DOGE\": \"19.988650\",\n \"DAI\": \"9.99\",\n \"WBTC\": \"0.000180\"\n },\n \"exchangeRates\": {\n \"BTC\": {\n \"USD\": 55413.609335,\n \"EUR\": 45540.39841,\n \"BCH\": 40.84109737914668,\n \"ETH\": 13.870219975470258,\n \"GUSD\": 55413.609335,\n \"PAX\": 55413.609335,\n \"BUSD\": 55413.609335,\n \"USDC\": 55413.609335,\n \"XRP\": 38758.09372049268,\n \"DOGE\": 110606.00665668662,\n \"DAI\": 55359.96552840298,\n \"WBTC\": 0.9981333606461704\n },\n \"BCH\": {\n \"USD\": 1352.90925,\n \"EUR\": 1111.2150000000001,\n \"BTC\": 0.02440102556111244,\n \"ETH\": 0.33863791096704754,\n \"GUSD\": 1352.90925,\n \"PAX\": 1352.90925,\n \"BUSD\": 1352.90925,\n \"USDC\": 1352.90925,\n \"XRP\": 946.2690507998013,\n \"DOGE\": 2700.4176646706587,\n \"DAI\": 1351.599550036015,\n \"WBTC\": 0.024369173431532262\n },\n \"ETH\": {\n \"USD\": 3992.672665000001,\n \"EUR\": 3278.9696950000002,\n \"BTC\": 0.0720117094001833,\n \"BCH\": 2.9426910658087726,\n \"GUSD\": 3992.672665000001,\n \"PAX\": 3992.672665000001,\n \"BUSD\": 3992.672665000001,\n \"USDC\": 3992.672665000001,\n \"XRP\": 2792.6060619837313,\n \"DOGE\": 7969.406516966069,\n \"DAI\": 3988.807510522304,\n \"WBTC\": 0.07191770817497412\n },\n \"GUSD\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"PAX\": 1,\n \"BUSD\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"PAX\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"BUSD\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"BUSD\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"PAX\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"USDC\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"PAX\": 1,\n \"BUSD\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"XRP\": {\n \"USD\": 1.4253776249999999,\n \"EUR\": 1.17088545,\n \"BTC\": 0.00002570806272620483,\n \"BCH\": 0.0010505359077542177,\n \"ETH\": 0.0003567769983605121,\n \"GUSD\": 1.4253776249999999,\n \"PAX\": 1.4253776249999999,\n \"BUSD\": 1.4253776249999999,\n \"USDC\": 1.4253776249999999,\n \"DOGE\": 2.845065119760479,\n \"DAI\": 1.423997771159746,\n \"WBTC\": 0.00002567450444222371\n },\n \"DOGE\": {\n \"USD\": 0.5002839,\n \"EUR\": 0.4110702732486,\n \"BTC\": 0.000009023103531676658,\n \"BCH\": 0.0003687206757025671,\n \"ETH\": 0.00012522280765428083,\n \"GUSD\": 0.5002839,\n \"PAX\": 0.5002839,\n \"BUSD\": 0.5002839,\n \"USDC\": 0.5002839,\n \"XRP\": 0.3499149489763802,\n \"DAI\": 0.49979959419322684,\n \"WBTC\": 0.000009011325130716152\n },\n \"DAI\": {\n \"USD\": 1.000968,\n \"EUR\": 0.822469380432,\n \"BTC\": 0.000018053425057043255,\n \"BCH\": 0.0007377363079576361,\n \"ETH\": 0.00025054578676645436,\n \"GUSD\": 1.000968,\n \"PAX\": 1.000968,\n \"BUSD\": 1.000968,\n \"USDC\": 1.000968,\n \"XRP\": 0.7001098109433249,\n \"DOGE\": 1.9979401197604791,\n \"WBTC\": 0.000018029858833039973\n },\n \"WBTC\": {\n \"USD\": 55466.58,\n \"EUR\": 45575.44665492,\n \"BTC\": 1.000393364423732,\n \"BCH\": 40.88013797068123,\n \"ETH\": 13.883478717945511,\n \"GUSD\": 55466.58,\n \"PAX\": 55466.58,\n \"BUSD\": 55466.58,\n \"USDC\": 55466.58,\n \"XRP\": 38795.14313891434,\n \"DOGE\": 110711.73652694612,\n \"DAI\": 55412.88491451783\n }\n },\n \"minerFees\": {\n \"BTC\": {\n \"satoshisPerByte\": 1,\n \"totalFee\": 100,\n \"fiatAmount\": 0.02\n },\n \"BCH\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"ETH\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"GUSD\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"PAX\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"BUSD\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"USDC\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"XRP\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"DOGE\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"DAI\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"WBTC\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n }\n },\n \"shopper\": {\n \"user\": \"FeFc5a7hUwmrEnYwVPmrkp\"\n },\n \"jsonPayProRequired\": false,\n \"merchantName\": \"Test Merchant\",\n \"bitpayIdRequired\": true,\n \"isCancelled\": false,\n \"itemizedDetails\": [\n {\n \"amount\": 5,\n \"description\": \"Item 1\",\n \"isFee\": false\n },\n {\n \"amount\": 15,\n \"description\": \"Item 2\",\n \"isFee\": false\n }\n ],\n \"transactionCurrency\": \"BCH\",\n \"supportedTransactionCurrencies\": {\n \"BTC\": {\n \"enabled\": true\n },\n \"BCH\": {\n \"enabled\": true\n },\n \"ETH\": {\n \"enabled\": true\n },\n \"GUSD\": {\n \"enabled\": true\n },\n \"PAX\": {\n \"enabled\": true\n },\n \"BUSD\": {\n \"enabled\": true\n },\n \"USDC\": {\n \"enabled\": true\n },\n \"XRP\": {\n \"enabled\": true\n },\n \"DOGE\": {\n \"enabled\": true\n },\n \"DAI\": {\n \"enabled\": true\n },\n \"WBTC\": {\n \"enabled\": true\n }\n },\n \"paymentCodes\": {\n \"BTC\": {\n \"BIP72b\": \"bitcoin:?r=https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\",\n \"BIP73\": \"https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\"\n },\n \"BCH\": {\n \"BIP72b\": \"bitcoincash:?r=https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\",\n \"BIP73\": \"https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\"\n },\n \"ETH\": {\n \"EIP681\": \"ethereum:?r=https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\"\n },\n \"GUSD\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\"\n },\n \"PAX\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\"\n },\n \"BUSD\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\"\n },\n \"USDC\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\"\n },\n \"XRP\": {\n \"BIP72b\": \"ripple:?r=https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\",\n \"BIP73\": \"https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\",\n \"RIP681\": \"https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\"\n },\n \"DOGE\": {\n \"BIP72b\": \"dogecoin:?r=https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\",\n \"BIP73\": \"https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\"\n },\n \"DAI\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\"\n },\n \"WBTC\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\"\n }\n },\n \"universalCodes\": {\n \"paymentString\": \"https://link.bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH\",\n \"verificationLink\": \"https://link.bitpay.com/i/KSnNNfoMDsbRzd1U9ypmVH?t=hv\"\n },\n \"token\": \"Svbfdow1xXc6chtQB3GVKqyRVhyLMqn3nhMhyTtf9T9vTCDKrVfdoA7n94nZUECZf\"\n },\n {\n \"url\": \"https://bitpay.com/invoice?id=G3viJEJgE8Jk2oekSdgT2A\",\n \"posData\": \"\\\"{ \\\"ref\\\" : 711454, \\\"item\\\" : \\\"test_item\\\" }\\\"\",\n \"status\": \"confirmed\",\n \"price\": 20,\n \"currency\": \"USD\",\n \"orderId\": \"20210511_fghij\",\n \"invoiceTime\": 1620733980748,\n \"expirationTime\": 1620734880748,\n \"currentTime\": 1620744196460,\n \"guid\": \"payment#5678\",\n \"id\": \"G3viJEJgE8Jk2oekSdgT2A\",\n \"lowFeeDetected\": false,\n \"amountPaid\": 744500,\n \"displayAmountPaid\": \"0.007445\",\n \"exceptionStatus\": false,\n \"targetConfirmations\": 6,\n \"transactions\": [\n {\n \"amount\": 744500,\n \"confirmations\": 6,\n \"receivedTime\": \"2021-05-11T12:03:01.526Z\",\n \"txid\": \"f35a1dff9ecf0e1cd87d6922eaa1d5e8faaca65efd84b2e5869e8ed7fcfb6fe4\",\n \"exRates\": {\n \"BCH\": 1,\n \"USD\": 1346.5200000000002,\n \"BTC\": 0.0244377406759562,\n \"EUR\": 1107.25,\n \"ETH\": 0.34117098582128125,\n \"GUSD\": 1346.5200000000002,\n \"PAX\": 1346.5200000000002,\n \"BUSD\": 1346.5200000000002,\n \"USDC\": 1346.5200000000002,\n \"XRP\": 951.2882646753377,\n \"DOGE\": 2779.8244514805524,\n \"DAI\": 1345.2003584483623,\n \"WBTC\": 0.024409662928680975\n },\n \"outputIndex\": 1\n }\n ],\n \"transactionSpeed\": \"medium\",\n \"buyer\": {\n \"email\": \"john@doe.com\"\n },\n \"redirectURL\": \"https://merchantwebsite.com/shop/return\",\n \"autoRedirect\": false,\n \"closeURL\": \"https://merchantwebsite.com/shop/cancel\",\n \"refundAddresses\": [],\n \"refundAddressRequestPending\": false,\n \"buyerProvidedEmail\": \"john@doe.com\",\n \"buyerProvidedInfo\": {\n \"emailAddress\": \"john@doe.com\",\n \"sms\": \"+12223334444\",\n \"smsVerified\": true,\n \"selectedWallet\": \"bitpay\",\n \"selectedTransactionCurrency\": \"BCH\",\n \"emailAddress\": \"john@doe.com\"\n },\n \"paymentSubtotals\": {\n \"BTC\": 18000,\n \"BCH\": 739100,\n \"ETH\": 2505000000000000,\n \"GUSD\": 1000,\n \"PAX\": 10000000000000000000,\n \"BUSD\": 10000000000000000000,\n \"USDC\": 10000000,\n \"XRP\": 7015685,\n \"DOGE\": 1998865000,\n \"DAI\": 9990000000000000000,\n \"WBTC\": 18000\n },\n \"paymentTotals\": {\n \"BTC\": 29600,\n \"BCH\": 739100,\n \"ETH\": 2505000000000000,\n \"GUSD\": 1000,\n \"PAX\": 10000000000000000000,\n \"BUSD\": 10000000000000000000,\n \"USDC\": 10000000,\n \"XRP\": 7015685,\n \"DOGE\": 1998865000,\n \"DAI\": 9990000000000000000,\n \"WBTC\": 18000\n },\n \"paymentDisplayTotals\": {\n \"BTC\": \"0.000296\",\n \"BCH\": \"0.007391\",\n \"ETH\": \"0.002505\",\n \"GUSD\": \"10.00\",\n \"PAX\": \"10.00\",\n \"BUSD\": \"10.00\",\n \"USDC\": \"10.00\",\n \"XRP\": \"7.015685\",\n \"DOGE\": \"19.988650\",\n \"DAI\": \"9.99\",\n \"WBTC\": \"0.000180\"\n },\n \"paymentDisplaySubTotals\": {\n \"BTC\": \"0.000180\",\n \"BCH\": \"0.007391\",\n \"ETH\": \"0.002505\",\n \"GUSD\": \"10.00\",\n \"PAX\": \"10.00\",\n \"BUSD\": \"10.00\",\n \"USDC\": \"10.00\",\n \"XRP\": \"7.015685\",\n \"DOGE\": \"19.988650\",\n \"DAI\": \"9.99\",\n \"WBTC\": \"0.000180\"\n },\n \"exchangeRates\": {\n \"BTC\": {\n \"USD\": 55413.609335,\n \"EUR\": 45540.39841,\n \"BCH\": 40.84109737914668,\n \"ETH\": 13.870219975470258,\n \"GUSD\": 55413.609335,\n \"PAX\": 55413.609335,\n \"BUSD\": 55413.609335,\n \"USDC\": 55413.609335,\n \"XRP\": 38758.09372049268,\n \"DOGE\": 110606.00665668662,\n \"DAI\": 55359.96552840298,\n \"WBTC\": 0.9981333606461704\n },\n \"BCH\": {\n \"USD\": 1352.90925,\n \"EUR\": 1111.2150000000001,\n \"BTC\": 0.02440102556111244,\n \"ETH\": 0.33863791096704754,\n \"GUSD\": 1352.90925,\n \"PAX\": 1352.90925,\n \"BUSD\": 1352.90925,\n \"USDC\": 1352.90925,\n \"XRP\": 946.2690507998013,\n \"DOGE\": 2700.4176646706587,\n \"DAI\": 1351.599550036015,\n \"WBTC\": 0.024369173431532262\n },\n \"ETH\": {\n \"USD\": 3992.672665000001,\n \"EUR\": 3278.9696950000002,\n \"BTC\": 0.0720117094001833,\n \"BCH\": 2.9426910658087726,\n \"GUSD\": 3992.672665000001,\n \"PAX\": 3992.672665000001,\n \"BUSD\": 3992.672665000001,\n \"USDC\": 3992.672665000001,\n \"XRP\": 2792.6060619837313,\n \"DOGE\": 7969.406516966069,\n \"DAI\": 3988.807510522304,\n \"WBTC\": 0.07191770817497412\n },\n \"GUSD\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"PAX\": 1,\n \"BUSD\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"PAX\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"BUSD\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"BUSD\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"PAX\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"USDC\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"PAX\": 1,\n \"BUSD\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"XRP\": {\n \"USD\": 1.4253776249999999,\n \"EUR\": 1.17088545,\n \"BTC\": 0.00002570806272620483,\n \"BCH\": 0.0010505359077542177,\n \"ETH\": 0.0003567769983605121,\n \"GUSD\": 1.4253776249999999,\n \"PAX\": 1.4253776249999999,\n \"BUSD\": 1.4253776249999999,\n \"USDC\": 1.4253776249999999,\n \"DOGE\": 2.845065119760479,\n \"DAI\": 1.423997771159746,\n \"WBTC\": 0.00002567450444222371\n },\n \"DOGE\": {\n \"USD\": 0.5002839,\n \"EUR\": 0.4110702732486,\n \"BTC\": 0.000009023103531676658,\n \"BCH\": 0.0003687206757025671,\n \"ETH\": 0.00012522280765428083,\n \"GUSD\": 0.5002839,\n \"PAX\": 0.5002839,\n \"BUSD\": 0.5002839,\n \"USDC\": 0.5002839,\n \"XRP\": 0.3499149489763802,\n \"DAI\": 0.49979959419322684,\n \"WBTC\": 0.000009011325130716152\n },\n \"DAI\": {\n \"USD\": 1.000968,\n \"EUR\": 0.822469380432,\n \"BTC\": 0.000018053425057043255,\n \"BCH\": 0.0007377363079576361,\n \"ETH\": 0.00025054578676645436,\n \"GUSD\": 1.000968,\n \"PAX\": 1.000968,\n \"BUSD\": 1.000968,\n \"USDC\": 1.000968,\n \"XRP\": 0.7001098109433249,\n \"DOGE\": 1.9979401197604791,\n \"WBTC\": 0.000018029858833039973\n },\n \"WBTC\": {\n \"USD\": 55466.58,\n \"EUR\": 45575.44665492,\n \"BTC\": 1.000393364423732,\n \"BCH\": 40.88013797068123,\n \"ETH\": 13.883478717945511,\n \"GUSD\": 55466.58,\n \"PAX\": 55466.58,\n \"BUSD\": 55466.58,\n \"USDC\": 55466.58,\n \"XRP\": 38795.14313891434,\n \"DOGE\": 110711.73652694612,\n \"DAI\": 55412.88491451783\n }\n },\n \"minerFees\": {\n \"BTC\": {\n \"satoshisPerByte\": 1,\n \"totalFee\": 100,\n \"fiatAmount\": 0.02\n },\n \"BCH\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"ETH\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"GUSD\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"PAX\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"BUSD\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"USDC\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"XRP\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"DOGE\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"DAI\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"WBTC\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n }\n },\n \"shopper\": {\n \"user\": \"FeFc5a7hUwmrEnYwVPmrkp\"\n },\n \"jsonPayProRequired\": false,\n \"merchantName\": \"Test Merchant\",\n \"bitpayIdRequired\": true,\n \"isCancelled\": false,\n \"itemizedDetails\": [\n {\n \"amount\": 5,\n \"description\": \"Item 1\",\n \"isFee\": false\n },\n {\n \"amount\": 15,\n \"description\": \"Item 2\",\n \"isFee\": false\n }\n ],\n \"transactionCurrency\": \"BCH\",\n \"supportedTransactionCurrencies\": {\n \"BTC\": {\n \"enabled\": true\n },\n \"BCH\": {\n \"enabled\": true\n },\n \"ETH\": {\n \"enabled\": true\n },\n \"GUSD\": {\n \"enabled\": true\n },\n \"PAX\": {\n \"enabled\": true\n },\n \"BUSD\": {\n \"enabled\": true\n },\n \"USDC\": {\n \"enabled\": true\n },\n \"XRP\": {\n \"enabled\": true\n },\n \"DOGE\": {\n \"enabled\": true\n },\n \"DAI\": {\n \"enabled\": true\n },\n \"WBTC\": {\n \"enabled\": true\n }\n },\n \"paymentCodes\": {\n \"BTC\": {\n \"BIP72b\": \"bitcoin:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"BCH\": {\n \"BIP72b\": \"bitcoincash:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"ETH\": {\n \"EIP681\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"GUSD\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"PAX\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"BUSD\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"USDC\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"XRP\": {\n \"BIP72b\": \"ripple:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"RIP681\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"DOGE\": {\n \"BIP72b\": \"dogecoin:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"DAI\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"WBTC\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n }\n },\n \"universalCodes\": {\n \"paymentString\": \"https://link.bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"verificationLink\": \"https://link.bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A?t=hv\"\n },\n \"token\": \"Svbfdow1xXc6chtQB3GVKqyRVhyLMqn3nhMhyTtf9T9vTCDKrVfdoA7n94nZUECZf\"\n }\n ]\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374167755cb9c00294ec5f0"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374164ec038610040ebede4"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"6374168a18b64e007e759b80"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"637416dbf2ff62001097f3b1"},{"name":"token","type":"string","enumValues":"","default":"","desc":"When fetching an invoice via the merchant or the pos facade, pass the API token as a URL parameter - the same token used to create the invoice in the first place.","required":true,"in":"query","ref":"","_id":"63742d630b130c000fe8596b"},{"name":"dateStart","type":"string","enumValues":"","default":"","desc":"The start of the date window to query for invoices. Format YYYY-MM-DD","required":true,"in":"query","ref":"","_id":"63742e9cc3ba8e0059a7eef7"},{"name":"dateEnd","type":"string","enumValues":"","default":"","desc":"The end of the date window to query for invoices. Format YYYY-MM-DD","required":true,"in":"query","ref":"","_id":"63742e9cc3ba8e0059a7eef6"},{"name":"status","type":"string","enumValues":"","default":"","desc":"The invoice status you want to query on","required":false,"in":"query","ref":"","_id":"63742e9cc3ba8e0059a7eef5"},{"name":"orderId","type":"string","enumValues":"","default":"","desc":"The optional order id specified at time of invoice creation","required":false,"in":"query","ref":"","_id":"63742ee62f2d230023e79276"},{"name":"limit","type":"int","enumValues":"","default":"","desc":"Maximum results that the query will return (useful for paging results)","required":false,"in":"query","ref":"","_id":"63742ee62f2d230023e79275"},{"name":"offset","type":"int","enumValues":"","default":"","desc":"Number of results to offset (ex. skip 10 will give you results starting with the 11th result)","required":false,"in":"query","ref":"","_id":"63742ee62f2d230023e79274"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Retrieve Invoices Filtered by Query","icon":"","type":"endpoint","slug":"retrieve-invoices-filtered-by-query","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"636c55f800204c00917a96fd","createdAt":"2022-11-16T00:27:28.350Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]},{"_id":"63742f3b12cfcf008c41f06b","api":{"method":"get","url":"/invoices/{invoiceId}/events","auth":"required","results":{"codes":[{"name":"","code":"{\n \"facade\": \"merchant/invoice\",\n \"data\": {\n \"url\": \"https://bitpay.com/events\",\n \"token\": \"4MuqDPt93i9Xbf8SnAPniwbGeNLW8A3ScgAmukFMgFUFRqTLuuhVdAFfePPysVqL2P\",\n \"events\": [\n \"payment\",\n \"confirmation\"\n ],\n \"actions\": [\n \"subscribe\",\n \"unsubscribe\"\n ]\n }\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374167755cb9c00294ec5f0"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374164ec038610040ebede4"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"6374168a18b64e007e759b80"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"637416dbf2ff62001097f3b1"},{"name":"token","type":"string","enumValues":"","default":"","desc":"When fetching an invoice via the merchant or the pos facade, pass the API token as a URL parameter - the same token used to create the invoice in the first place.","required":true,"in":"query","ref":"","_id":"63742d630b130c000fe8596b"},{"name":"invoiceId","type":"string","enumValues":"","default":"","desc":"The ID of the invoice to retrieve an event token for","required":false,"in":"path","ref":"","_id":"63742f3b12cfcf008c41f06c"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Retrieve an Event Token","icon":"","type":"endpoint","slug":"retrieve-an-event-token","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"636c55f800204c00917a96fd","createdAt":"2022-11-16T00:30:51.679Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":false,"children":[]},{"_id":"63742f8ef58587008b190fcf","api":{"method":"delete","url":"/invoices/{invoiceId}","auth":"required","results":{"codes":[{"name":"","code":"{\n \"facade\": \"merchant/invoice\",\n \"data\": {\n \"url\": \"https://bitpay.com/invoice?id=G3viJEJgE8Jk2oekSdgT2A\",\n \"posData\": \"\\\"{ \\\"ref\\\" : 711454, \\\"item\\\" : \\\"test_item\\\" }\\\"\",\n \"status\": \"expired\",\n \"price\": 20,\n \"currency\": \"USD\",\n \"orderId\": \"20210511_fghij\",\n \"invoiceTime\": 1620733980748,\n \"expirationTime\": 1620734880748,\n \"currentTime\": 1620734253073,\n \"guid\": \"payment#1234\",\n \"id\": \"G3viJEJgE8Jk2oekSdgT2A\",\n \"lowFeeDetected\": false,\n \"amountPaid\": 739100,\n \"displayAmountPaid\": \"0.007391\",\n \"exceptionStatus\": false,\n \"targetConfirmations\": 6,\n \"transactions\": [\n ],\n \"transactionSpeed\": \"medium\",\n \"buyer\": {\n \"email\": \"john@doe.com\"\n },\n \"redirectURL\": \"https://merchantwebsite.com/shop/return\",\n \"autoRedirect\": false,\n \"closeURL\": \"https://merchantwebsite.com/shop/cancel\",\n \"refundAddresses\": [],\n \"refundAddressRequestPending\": false,\n \"buyerProvidedEmail\": \"john@doe.com\",\n \"buyerProvidedInfo\": {\n \"emailAddress\": \"john@doe.com\",\n \"sms\": \"+12223334444\",\n \"smsVerified\": true,\n \"selectedWallet\": \"bitpay\",\n \"selectedTransactionCurrency\": \"BCH\",\n \"emailAddress\": \"john@doe.com\"\n },\n \"paymentSubtotals\": {\n \"BTC\": 18000,\n \"BCH\": 739100,\n \"ETH\": 2505000000000000,\n \"GUSD\": 1000,\n \"PAX\": 10000000000000000000,\n \"BUSD\": 10000000000000000000,\n \"USDC\": 10000000,\n \"XRP\": 7015685,\n \"DOGE\": 1998865000,\n \"DAI\": 9990000000000000000,\n \"WBTC\": 18000\n },\n \"paymentTotals\": {\n \"BTC\": 29600,\n \"BCH\": 739100,\n \"ETH\": 2505000000000000,\n \"GUSD\": 1000,\n \"PAX\": 10000000000000000000,\n \"BUSD\": 10000000000000000000,\n \"USDC\": 10000000,\n \"XRP\": 7015685,\n \"DOGE\": 1998865000,\n \"DAI\": 9990000000000000000,\n \"WBTC\": 18000\n },\n \"paymentDisplayTotals\": {\n \"BTC\": \"0.000296\",\n \"BCH\": \"0.007391\",\n \"ETH\": \"0.002505\",\n \"GUSD\": \"10.00\",\n \"PAX\": \"10.00\",\n \"BUSD\": \"10.00\",\n \"USDC\": \"10.00\",\n \"XRP\": \"7.015685\",\n \"DOGE\": \"19.988650\",\n \"DAI\": \"9.99\",\n \"WBTC\": \"0.000180\"\n },\n \"paymentDisplaySubTotals\": {\n \"BTC\": \"0.000180\",\n \"BCH\": \"0.007391\",\n \"ETH\": \"0.002505\",\n \"GUSD\": \"10.00\",\n \"PAX\": \"10.00\",\n \"BUSD\": \"10.00\",\n \"USDC\": \"10.00\",\n \"XRP\": \"7.015685\",\n \"DOGE\": \"19.988650\",\n \"DAI\": \"9.99\",\n \"WBTC\": \"0.000180\"\n },\n \"exchangeRates\": {\n \"BTC\": {\n \"USD\": 55413.609335,\n \"EUR\": 45540.39841,\n \"BCH\": 40.84109737914668,\n \"ETH\": 13.870219975470258,\n \"GUSD\": 55413.609335,\n \"PAX\": 55413.609335,\n \"BUSD\": 55413.609335,\n \"USDC\": 55413.609335,\n \"XRP\": 38758.09372049268,\n \"DOGE\": 110606.00665668662,\n \"DAI\": 55359.96552840298,\n \"WBTC\": 0.9981333606461704\n },\n \"BCH\": {\n \"USD\": 1352.90925,\n \"EUR\": 1111.2150000000001,\n \"BTC\": 0.02440102556111244,\n \"ETH\": 0.33863791096704754,\n \"GUSD\": 1352.90925,\n \"PAX\": 1352.90925,\n \"BUSD\": 1352.90925,\n \"USDC\": 1352.90925,\n \"XRP\": 946.2690507998013,\n \"DOGE\": 2700.4176646706587,\n \"DAI\": 1351.599550036015,\n \"WBTC\": 0.024369173431532262\n },\n \"ETH\": {\n \"USD\": 3992.672665000001,\n \"EUR\": 3278.9696950000002,\n \"BTC\": 0.0720117094001833,\n \"BCH\": 2.9426910658087726,\n \"GUSD\": 3992.672665000001,\n \"PAX\": 3992.672665000001,\n \"BUSD\": 3992.672665000001,\n \"USDC\": 3992.672665000001,\n \"XRP\": 2792.6060619837313,\n \"DOGE\": 7969.406516966069,\n \"DAI\": 3988.807510522304,\n \"WBTC\": 0.07191770817497412\n },\n \"GUSD\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"PAX\": 1,\n \"BUSD\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"PAX\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"BUSD\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"BUSD\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"PAX\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"USDC\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"PAX\": 1,\n \"BUSD\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"XRP\": {\n \"USD\": 1.4253776249999999,\n \"EUR\": 1.17088545,\n \"BTC\": 0.00002570806272620483,\n \"BCH\": 0.0010505359077542177,\n \"ETH\": 0.0003567769983605121,\n \"GUSD\": 1.4253776249999999,\n \"PAX\": 1.4253776249999999,\n \"BUSD\": 1.4253776249999999,\n \"USDC\": 1.4253776249999999,\n \"DOGE\": 2.845065119760479,\n \"DAI\": 1.423997771159746,\n \"WBTC\": 0.00002567450444222371\n },\n \"DOGE\": {\n \"USD\": 0.5002839,\n \"EUR\": 0.4110702732486,\n \"BTC\": 0.000009023103531676658,\n \"BCH\": 0.0003687206757025671,\n \"ETH\": 0.00012522280765428083,\n \"GUSD\": 0.5002839,\n \"PAX\": 0.5002839,\n \"BUSD\": 0.5002839,\n \"USDC\": 0.5002839,\n \"XRP\": 0.3499149489763802,\n \"DAI\": 0.49979959419322684,\n \"WBTC\": 0.000009011325130716152\n },\n \"DAI\": {\n \"USD\": 1.000968,\n \"EUR\": 0.822469380432,\n \"BTC\": 0.000018053425057043255,\n \"BCH\": 0.0007377363079576361,\n \"ETH\": 0.00025054578676645436,\n \"GUSD\": 1.000968,\n \"PAX\": 1.000968,\n \"BUSD\": 1.000968,\n \"USDC\": 1.000968,\n \"XRP\": 0.7001098109433249,\n \"DOGE\": 1.9979401197604791,\n \"WBTC\": 0.000018029858833039973\n },\n \"WBTC\": {\n \"USD\": 55466.58,\n \"EUR\": 45575.44665492,\n \"BTC\": 1.000393364423732,\n \"BCH\": 40.88013797068123,\n \"ETH\": 13.883478717945511,\n \"GUSD\": 55466.58,\n \"PAX\": 55466.58,\n \"BUSD\": 55466.58,\n \"USDC\": 55466.58,\n \"XRP\": 38795.14313891434,\n \"DOGE\": 110711.73652694612,\n \"DAI\": 55412.88491451783\n }\n },\n \"minerFees\": {\n \"BTC\": {\n \"satoshisPerByte\": 1,\n \"totalFee\": 100,\n \"fiatAmount\": 0.02\n },\n \"BCH\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"ETH\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"GUSD\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"PAX\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"BUSD\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"USDC\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"XRP\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"DOGE\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"DAI\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"WBTC\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n }\n },\n \"shopper\": {\n \"user\": \"FeFc5a7hUwmrEnYwVPmrkp\"\n },\n \"jsonPayProRequired\": false,\n \"merchantName\": \"Test Merchant\",\n \"bitpayIdRequired\": true,\n \"isCancelled\": true,\n \"itemizedDetails\": [\n {\n \"amount\": 5,\n \"description\": \"Item 1\",\n \"isFee\": false\n },\n {\n \"amount\": 15,\n \"description\": \"Item 2\",\n \"isFee\": false\n }\n ],\n \"transactionCurrency\": \"BCH\",\n \"supportedTransactionCurrencies\": {\n \"BTC\": {\n \"enabled\": true\n },\n \"BCH\": {\n \"enabled\": true\n },\n \"ETH\": {\n \"enabled\": true\n },\n \"GUSD\": {\n \"enabled\": true\n },\n \"PAX\": {\n \"enabled\": true\n },\n \"BUSD\": {\n \"enabled\": true\n },\n \"USDC\": {\n \"enabled\": true\n },\n \"XRP\": {\n \"enabled\": true\n },\n \"DOGE\": {\n \"enabled\": true\n },\n \"DAI\": {\n \"enabled\": true\n },\n \"WBTC\": {\n \"enabled\": true\n }\n },\n \"paymentCodes\": {\n \"BTC\": {\n \"BIP72b\": \"bitcoin:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"BCH\": {\n \"BIP72b\": \"bitcoincash:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"ETH\": {\n \"EIP681\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"GUSD\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"PAX\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"BUSD\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"USDC\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"XRP\": {\n \"BIP72b\": \"ripple:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"RIP681\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"DOGE\": {\n \"BIP72b\": \"dogecoin:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"DAI\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"WBTC\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n }\n },\n \"universalCodes\": {\n \"paymentString\": \"https://link.bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"verificationLink\": \"https://link.bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A?t=hv\"\n },\n \"token\": \"Svbfdow1xXc6chtQB3GVKqyRVhyLMqn3nhMhyTtf9T9vTCDKrVfdoA7n94nZUECZf\"\n }\n}","language":"json","status":200},{"code":"{\n \"status\": \"error\",\n \"code\": \"040107\",\n \"data\": null,\n \"error\": \"Invalid invoice state for cancel\"\n}","language":"text","status":"5XX"}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374167755cb9c00294ec5f0"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374164ec038610040ebede4"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"6374168a18b64e007e759b80"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"637416dbf2ff62001097f3b1"},{"name":"token","type":"string","enumValues":"","default":"","desc":"When fetching an invoice via the merchant or the pos facade, pass the API token as a URL parameter - the same token used to create the invoice in the first place.","required":true,"in":"query","ref":"","_id":"63742d630b130c000fe8596b"},{"name":"invoiceId","type":"string","enumValues":"","default":"","desc":"The id of the invoice for which you want to cancel.","required":false,"in":"path","ref":"","_id":"63742f3b12cfcf008c41f06c"},{"name":"forceCancel","type":"string","enumValues":"","default":"","desc":"Parameter that will cancel the invoice even if no contact information is present. Note: Canceling a paid invoice without contact information requires a manual support process and is not recommended.","required":false,"in":"query","ref":"","_id":"63742fb53f57e8029498fce4"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Cancel an Invoice","icon":"","type":"endpoint","slug":"cancel-an-invoice","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"636c55f800204c00917a96fd","createdAt":"2022-11-16T00:32:14.662Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":false,"children":[]},{"_id":"63f2c42a3af9fe00344e009a","api":{"method":"delete","url":"/invoices/guid/{guid}","auth":"required","results":{"codes":[{"name":"","code":"{\n \"facade\": \"merchant/invoice\",\n \"data\": {\n \"url\": \"https://bitpay.com/invoice?id=G3viJEJgE8Jk2oekSdgT2A\",\n \"posData\": \"\\\"{ \\\"ref\\\" : 711454, \\\"item\\\" : \\\"test_item\\\" }\\\"\",\n \"status\": \"expired\",\n \"price\": 20,\n \"currency\": \"USD\",\n \"orderId\": \"20210511_fghij\",\n \"invoiceTime\": 1620733980748,\n \"expirationTime\": 1620734880748,\n \"currentTime\": 1620734253073,\n \"guid\": \"payment#1234\",\n \"id\": \"G3viJEJgE8Jk2oekSdgT2A\",\n \"lowFeeDetected\": false,\n \"amountPaid\": 739100,\n \"displayAmountPaid\": \"0.007391\",\n \"exceptionStatus\": false,\n \"targetConfirmations\": 6,\n \"transactions\": [\n ],\n \"transactionSpeed\": \"medium\",\n \"buyer\": {\n \"email\": \"john@doe.com\"\n },\n \"redirectURL\": \"https://merchantwebsite.com/shop/return\",\n \"autoRedirect\": false,\n \"closeURL\": \"https://merchantwebsite.com/shop/cancel\",\n \"refundAddresses\": [],\n \"refundAddressRequestPending\": false,\n \"buyerProvidedEmail\": \"john@doe.com\",\n \"buyerProvidedInfo\": {\n \"emailAddress\": \"john@doe.com\",\n \"sms\": \"+12223334444\",\n \"smsVerified\": true,\n \"selectedWallet\": \"bitpay\",\n \"selectedTransactionCurrency\": \"BCH\",\n \"emailAddress\": \"john@doe.com\"\n },\n \"paymentSubtotals\": {\n \"BTC\": 18000,\n \"BCH\": 739100,\n \"ETH\": 2505000000000000,\n \"GUSD\": 1000,\n \"PAX\": 10000000000000000000,\n \"BUSD\": 10000000000000000000,\n \"USDC\": 10000000,\n \"XRP\": 7015685,\n \"DOGE\": 1998865000,\n \"DAI\": 9990000000000000000,\n \"WBTC\": 18000\n },\n \"paymentTotals\": {\n \"BTC\": 29600,\n \"BCH\": 739100,\n \"ETH\": 2505000000000000,\n \"GUSD\": 1000,\n \"PAX\": 10000000000000000000,\n \"BUSD\": 10000000000000000000,\n \"USDC\": 10000000,\n \"XRP\": 7015685,\n \"DOGE\": 1998865000,\n \"DAI\": 9990000000000000000,\n \"WBTC\": 18000\n },\n \"paymentDisplayTotals\": {\n \"BTC\": \"0.000296\",\n \"BCH\": \"0.007391\",\n \"ETH\": \"0.002505\",\n \"GUSD\": \"10.00\",\n \"PAX\": \"10.00\",\n \"BUSD\": \"10.00\",\n \"USDC\": \"10.00\",\n \"XRP\": \"7.015685\",\n \"DOGE\": \"19.988650\",\n \"DAI\": \"9.99\",\n \"WBTC\": \"0.000180\"\n },\n \"paymentDisplaySubTotals\": {\n \"BTC\": \"0.000180\",\n \"BCH\": \"0.007391\",\n \"ETH\": \"0.002505\",\n \"GUSD\": \"10.00\",\n \"PAX\": \"10.00\",\n \"BUSD\": \"10.00\",\n \"USDC\": \"10.00\",\n \"XRP\": \"7.015685\",\n \"DOGE\": \"19.988650\",\n \"DAI\": \"9.99\",\n \"WBTC\": \"0.000180\"\n },\n \"exchangeRates\": {\n \"BTC\": {\n \"USD\": 55413.609335,\n \"EUR\": 45540.39841,\n \"BCH\": 40.84109737914668,\n \"ETH\": 13.870219975470258,\n \"GUSD\": 55413.609335,\n \"PAX\": 55413.609335,\n \"BUSD\": 55413.609335,\n \"USDC\": 55413.609335,\n \"XRP\": 38758.09372049268,\n \"DOGE\": 110606.00665668662,\n \"DAI\": 55359.96552840298,\n \"WBTC\": 0.9981333606461704\n },\n \"BCH\": {\n \"USD\": 1352.90925,\n \"EUR\": 1111.2150000000001,\n \"BTC\": 0.02440102556111244,\n \"ETH\": 0.33863791096704754,\n \"GUSD\": 1352.90925,\n \"PAX\": 1352.90925,\n \"BUSD\": 1352.90925,\n \"USDC\": 1352.90925,\n \"XRP\": 946.2690507998013,\n \"DOGE\": 2700.4176646706587,\n \"DAI\": 1351.599550036015,\n \"WBTC\": 0.024369173431532262\n },\n \"ETH\": {\n \"USD\": 3992.672665000001,\n \"EUR\": 3278.9696950000002,\n \"BTC\": 0.0720117094001833,\n \"BCH\": 2.9426910658087726,\n \"GUSD\": 3992.672665000001,\n \"PAX\": 3992.672665000001,\n \"BUSD\": 3992.672665000001,\n \"USDC\": 3992.672665000001,\n \"XRP\": 2792.6060619837313,\n \"DOGE\": 7969.406516966069,\n \"DAI\": 3988.807510522304,\n \"WBTC\": 0.07191770817497412\n },\n \"GUSD\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"PAX\": 1,\n \"BUSD\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"PAX\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"BUSD\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"BUSD\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"PAX\": 1,\n \"USDC\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"USDC\": {\n \"USD\": 1,\n \"EUR\": 0.821674,\n \"BTC\": 0.000018035966241721267,\n \"BCH\": 0.0007370228698196506,\n \"ETH\": 0.0002503034929852446,\n \"GUSD\": 1,\n \"PAX\": 1,\n \"BUSD\": 1,\n \"XRP\": 0.6994327600316144,\n \"DOGE\": 1.9960079840319362,\n \"DAI\": 0.9990319380520276,\n \"WBTC\": 0.000018012422807762058\n },\n \"XRP\": {\n \"USD\": 1.4253776249999999,\n \"EUR\": 1.17088545,\n \"BTC\": 0.00002570806272620483,\n \"BCH\": 0.0010505359077542177,\n \"ETH\": 0.0003567769983605121,\n \"GUSD\": 1.4253776249999999,\n \"PAX\": 1.4253776249999999,\n \"BUSD\": 1.4253776249999999,\n \"USDC\": 1.4253776249999999,\n \"DOGE\": 2.845065119760479,\n \"DAI\": 1.423997771159746,\n \"WBTC\": 0.00002567450444222371\n },\n \"DOGE\": {\n \"USD\": 0.5002839,\n \"EUR\": 0.4110702732486,\n \"BTC\": 0.000009023103531676658,\n \"BCH\": 0.0003687206757025671,\n \"ETH\": 0.00012522280765428083,\n \"GUSD\": 0.5002839,\n \"PAX\": 0.5002839,\n \"BUSD\": 0.5002839,\n \"USDC\": 0.5002839,\n \"XRP\": 0.3499149489763802,\n \"DAI\": 0.49979959419322684,\n \"WBTC\": 0.000009011325130716152\n },\n \"DAI\": {\n \"USD\": 1.000968,\n \"EUR\": 0.822469380432,\n \"BTC\": 0.000018053425057043255,\n \"BCH\": 0.0007377363079576361,\n \"ETH\": 0.00025054578676645436,\n \"GUSD\": 1.000968,\n \"PAX\": 1.000968,\n \"BUSD\": 1.000968,\n \"USDC\": 1.000968,\n \"XRP\": 0.7001098109433249,\n \"DOGE\": 1.9979401197604791,\n \"WBTC\": 0.000018029858833039973\n },\n \"WBTC\": {\n \"USD\": 55466.58,\n \"EUR\": 45575.44665492,\n \"BTC\": 1.000393364423732,\n \"BCH\": 40.88013797068123,\n \"ETH\": 13.883478717945511,\n \"GUSD\": 55466.58,\n \"PAX\": 55466.58,\n \"BUSD\": 55466.58,\n \"USDC\": 55466.58,\n \"XRP\": 38795.14313891434,\n \"DOGE\": 110711.73652694612,\n \"DAI\": 55412.88491451783\n }\n },\n \"minerFees\": {\n \"BTC\": {\n \"satoshisPerByte\": 1,\n \"totalFee\": 100,\n \"fiatAmount\": 0.02\n },\n \"BCH\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"ETH\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"GUSD\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"PAX\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"BUSD\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"USDC\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"XRP\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"DOGE\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"DAI\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n },\n \"WBTC\": {\n \"satoshisPerByte\": 0,\n \"totalFee\": 0,\n \"fiatAmount\": 0\n }\n },\n \"shopper\": {\n \"user\": \"FeFc5a7hUwmrEnYwVPmrkp\"\n },\n \"jsonPayProRequired\": false,\n \"merchantName\": \"Test Merchant\",\n \"bitpayIdRequired\": true,\n \"isCancelled\": true,\n \"itemizedDetails\": [\n {\n \"amount\": 5,\n \"description\": \"Item 1\",\n \"isFee\": false\n },\n {\n \"amount\": 15,\n \"description\": \"Item 2\",\n \"isFee\": false\n }\n ],\n \"transactionCurrency\": \"BCH\",\n \"supportedTransactionCurrencies\": {\n \"BTC\": {\n \"enabled\": true\n },\n \"BCH\": {\n \"enabled\": true\n },\n \"ETH\": {\n \"enabled\": true\n },\n \"GUSD\": {\n \"enabled\": true\n },\n \"PAX\": {\n \"enabled\": true\n },\n \"BUSD\": {\n \"enabled\": true\n },\n \"USDC\": {\n \"enabled\": true\n },\n \"XRP\": {\n \"enabled\": true\n },\n \"DOGE\": {\n \"enabled\": true\n },\n \"DAI\": {\n \"enabled\": true\n },\n \"WBTC\": {\n \"enabled\": true\n }\n },\n \"paymentCodes\": {\n \"BTC\": {\n \"BIP72b\": \"bitcoin:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"BCH\": {\n \"BIP72b\": \"bitcoincash:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"ETH\": {\n \"EIP681\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"GUSD\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"PAX\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"BUSD\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"USDC\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"XRP\": {\n \"BIP72b\": \"ripple:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"RIP681\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"DOGE\": {\n \"BIP72b\": \"dogecoin:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"BIP73\": \"https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"DAI\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n },\n \"WBTC\": {\n \"EIP681b\": \"ethereum:?r=https://bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\"\n }\n },\n \"universalCodes\": {\n \"paymentString\": \"https://link.bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A\",\n \"verificationLink\": \"https://link.bitpay.com/i/G3viJEJgE8Jk2oekSdgT2A?t=hv\"\n },\n \"token\": \"Svbfdow1xXc6chtQB3GVKqyRVhyLMqn3nhMhyTtf9T9vTCDKrVfdoA7n94nZUECZf\"\n }\n}","language":"json","status":200},{"code":"{\n \"status\": \"error\",\n \"code\": \"040107\",\n \"data\": null,\n \"error\": \"Invalid invoice state for cancel\"\n}","language":"text","status":"5XX"}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374167755cb9c00294ec5f0"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374164ec038610040ebede4"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"6374168a18b64e007e759b80"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"637416dbf2ff62001097f3b1"},{"name":"token","type":"string","enumValues":"","default":"","desc":"When fetching an invoice via the merchant or the pos facade, pass the API token as a URL parameter - the same token used to create the invoice in the first place.","required":true,"in":"query","ref":"","_id":"63742d630b130c000fe8596b"},{"name":"guid","type":"string","enumValues":"","default":"","desc":"The guid of the invoice for which you want to cancel.","required":false,"in":"path","ref":"","_id":"63742f3b12cfcf008c41f06c"},{"name":"forceCancel","type":"string","enumValues":"","default":"","desc":"Parameter that will cancel the invoice even if no contact information is present. Note: Canceling a paid invoice without contact information requires a manual support process and is not recommended.","required":false,"in":"query","ref":"","_id":"63742fb53f57e8029498fce4"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Cancel an Invoice by GUID","icon":"","type":"endpoint","slug":"cancel-an-invoice-by-guid","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"636c55f800204c00917a96fd","category":"636c2e44f41a34006b3b0db2","createdAt":"2023-02-20T00:51:54.382Z","isBodyEmpty":false,"children":[]},{"_id":"63743328d88f4a000fab6e03","api":{"method":"post","url":"/invoices/{invoiceId}/notifications","auth":"required","results":{"codes":[{"name":"","code":"{\n \"data\": \"Success\"\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374167755cb9c00294ec5f0"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374164ec038610040ebede4"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"6374168a18b64e007e759b80"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"637416dbf2ff62001097f3b1"},{"name":"invoiceId","type":"string","enumValues":"","default":"","desc":"The id of the invoice for which you want the last webhook to be resent.","required":false,"in":"path","ref":"","_id":"63742f3b12cfcf008c41f06c"},{"name":"token","type":"string","enumValues":"","default":"","desc":"The resource token for the invoiceId you want the webhook to be resent. You first need to retrieve this token from the invoice object itself, using the merchant facade (see section Retrieve an invoice).","required":true,"in":"body","ref":"","_id":"63743328d88f4a000fab6e04"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Request an Invoice Webhook to be Resent","icon":"","type":"endpoint","slug":"request-an-invoice-webhook-to-be-resent","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"request-a-webhook-to-be-resent","parentDoc":"636c55f800204c00917a96fd","createdAt":"2022-11-16T00:47:36.681Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":false,"children":[]}]},{"_id":"63716ab829c668003370bc56","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Refunds","icon":"","type":"basic","slug":"refunds","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-13T22:07:52.023Z","category":"636c2e44f41a34006b3b0db2","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"637578d1c80af9007a7c5e8c","api":{"method":"post","url":"/refunds","auth":"never","results":{"codes":[{"name":"","code":"{\n \"data\": {\n \"id\": \"WoE46gSLkJQS48RJEiNw3L\",\n \"invoice\": \"Hpqc63wvE1ZjzeeH4kEycF\",\n \"reference\": \"Test refund\",\n \"status\": \"created\",\n \"amount\": 10,\n \"transactionCurrency\": \"BTC\",\n \"transactionAmount\": 0.000594,\n \"transactionRefundFee\": 0.000002,\n \"currency\": \"USD\",\n \"lastRefundNotification\": \"2021-08-29T20:45:35.368Z\",\n \"refundFee\": 0.04,\n \"immediate\": false,\n \"buyerPaysRefundFee\": false,\n \"requestDate\": \"2021-08-29T20:45:34.000Z\"\n }\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191021"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191020"},{"name":"amount","type":"double","enumValues":"","default":"","desc":"The amount to be refunded, denominated in the invoice original currency - partial refunds are supported","required":true,"in":"body","ref":"","_id":"636c50f41dfbc5045d19101f"},{"name":"invoiceId","type":"string","enumValues":"","default":"","desc":"The ID of the invoice to refund.","required":true,"in":"body","ref":"","_id":"63757987aace47003adb8979"},{"name":"token","type":"string","enumValues":"","default":"","desc":"The API token used when originally creating the invoice.","required":true,"in":"body","ref":"","_id":"63757987aace47003adb8978"},{"name":"preview","type":"boolean","enumValues":"","default":"false","desc":"Whether to create the refund request as a preview (which will not be acted on until status is updated) - parameter defaults to `false` if not passed.","required":false,"in":"body","ref":"","_id":"63757987aace47003adb8977"},{"name":"immediate","type":"boolean","enumValues":"","default":"false","desc":"Whether funds should be removed from merchant ledger immediately on submission or at time of processing - parameter defaults to `false` if not passed.","required":false,"in":"body","ref":"","_id":"63757987aace47003adb8976"},{"name":"buyerPaysRefundFee","type":"boolean","enumValues":"","default":"false","desc":"Whether the buyer should pay the refund fee rather than the merchant - parameter defaults to false if not passed.","required":false,"in":"body","ref":"","_id":"63757987aace47003adb8975"},{"name":"reference","type":"string","enumValues":"","default":"","desc":"Present only if specified in the request to create the refund. This is your reference label for this refund. It will be passed-through on each response for you to identify the refund in your system. Maximum string length is 100 characters.","required":false,"in":"body","ref":"","_id":"63757987aace47003adb8974"},{"name":"guid","type":"string","enumValues":"","default":"","desc":"A variable provided by the merchant and designed to be used by the merchant to correlate the refund with a refund ID in their system.","required":false,"in":"body","ref":"","_id":"6393ce41ce18f8009a637388"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Create a Refund Request","icon":"","type":"endpoint","slug":"create-a-refund-request","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-a-refund","parentDoc":"63716ab829c668003370bc56","createdAt":"2022-11-16T23:57:05.717Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":false,"children":[]},{"_id":"637579dfd0476700856d8e2d","api":{"method":"put","url":"/refunds/{refundId}","auth":"never","results":{"codes":[{"name":"","code":"{\n \"data\": {\n \"id\": \"WoE46gSLkJQS48RJEiNw3L\",\n \"invoice\": \"Hpqc63wvE1ZjzeeH4kEycF\",\n \"reference\": \"Test refund\",\n \"status\": \"created\",\n \"amount\": 10,\n \"transactionCurrency\": \"BTC\",\n \"transactionAmount\": 0.000594,\n \"transactionRefundFee\": 0.000002,\n \"currency\": \"USD\",\n \"lastRefundNotification\": \"2021-08-29T20:45:35.368Z\",\n \"refundFee\": 0.04,\n \"immediate\": false,\n \"buyerPaysRefundFee\": false,\n \"requestDate\": \"2021-08-29T20:45:34.000Z\"\n }\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191021"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191020"},{"name":"refundId","type":"string","enumValues":"","default":"","desc":"The ID of the refund to update","required":false,"in":"path","ref":"","_id":"63757a865d284900961fddd9"},{"name":"status","type":"string","enumValues":"","default":"","desc":"Set to `created` in order to confirm the refund request and initiate the flow to send it to shopper.","required":false,"in":"body","ref":"","_id":"63757a865d284900961fddd8"},{"name":"token","type":"string","enumValues":"","default":"","desc":"Approved merchant facade token.","required":true,"in":"body","ref":"","_id":"63757a865d284900961fddd7"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Update a Refund Request","icon":"","type":"endpoint","slug":"update-a-refund-request","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"update-a-refund","parentDoc":"63716ab829c668003370bc56","createdAt":"2022-11-17T00:01:35.785Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]},{"_id":"6393cee69f07300016468c92","api":{"method":"put","url":"/refunds/guid/{guid}","auth":"never","results":{"codes":[{"name":"","code":"{\n \"data\": {\n \"id\": \"WoE46gSLkJQS48RJEiNw3L\",\n \"invoice\": \"Hpqc63wvE1ZjzeeH4kEycF\",\n \"reference\": \"Test refund\",\n \"status\": \"created\",\n \"amount\": 10,\n \"transactionCurrency\": \"BTC\",\n \"transactionAmount\": 0.000594,\n \"transactionRefundFee\": 0.000002,\n \"currency\": \"USD\",\n \"lastRefundNotification\": \"2021-08-29T20:45:35.368Z\",\n \"refundFee\": 0.04,\n \"immediate\": false,\n \"buyerPaysRefundFee\": false,\n \"requestDate\": \"2021-08-29T20:45:34.000Z\"\n }\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191021"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191020"},{"name":"guid","type":"string","enumValues":"","default":"","desc":"A variable provided by the merchant and designed to be used by the merchant to correlate the refund with a refund ID in their system.","required":false,"in":"path","ref":"","_id":"63757a865d284900961fddd9"},{"name":"status","type":"string","enumValues":"","default":"","desc":"Set to `created` in order to confirm the refund request and initiate the flow to send it to shopper.","required":false,"in":"body","ref":"","_id":"63757a865d284900961fddd8"},{"name":"token","type":"string","enumValues":"","default":"","desc":"Approved merchant facade token.","required":true,"in":"body","ref":"","_id":"63757a865d284900961fddd7"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Update a Refund by GUID Request","icon":"","type":"endpoint","slug":"update-a-refund-by-guid-request","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716ab829c668003370bc56","createdAt":"2022-12-10T00:12:22.355Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]},{"_id":"63757ae5a688f100e80977a0","api":{"method":"get","url":"/refunds/{refundId}","auth":"never","results":{"codes":[{"name":"","code":"{\n \"data\": {\n \"id\": \"WoE46gSLkJQS48RJEiNw3L\",\n \"invoice\": \"Hpqc63wvE1ZjzeeH4kEycF\",\n \"reference\": \"Test refund\",\n \"status\": \"created\",\n \"amount\": 10,\n \"transactionCurrency\": \"BTC\",\n \"transactionAmount\": 0.000594,\n \"transactionRefundFee\": 0.000002,\n \"currency\": \"USD\",\n \"lastRefundNotification\": \"2021-08-29T20:45:35.368Z\",\n \"refundFee\": 0.04,\n \"immediate\": false,\n \"buyerPaysRefundFee\": false,\n \"requestDate\": \"2021-08-29T20:45:34.000Z\"\n }\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":false,"in":"header","ref":"","_id":"636c50f41dfbc5045d191021"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":false,"in":"header","ref":"","_id":"636c50f41dfbc5045d191020"},{"name":"refundId","type":"string","enumValues":"","default":"","desc":"The ID of the refund request being retrieved.","required":false,"in":"path","ref":"","_id":"63757a865d284900961fddd9"},{"name":"token","type":"string","enumValues":"","default":"","desc":"When fetching a refund via the `merchant` facade, pass the API token as a URL parameter - the same token used to create the invoice in the first place.","required":true,"in":"query","ref":"","_id":"63757ae5a688f100e80977a1"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Retrieve a Refund Request","icon":"","type":"endpoint","slug":"retrieve-a-refund-request","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-a-refund","parentDoc":"63716ab829c668003370bc56","createdAt":"2022-11-17T00:05:57.996Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]},{"_id":"6393cf308f6efe004aef90f3","api":{"method":"get","url":"/refunds//guid/{guid}","auth":"never","results":{"codes":[{"name":"","code":"{\n \"data\": {\n \"id\": \"WoE46gSLkJQS48RJEiNw3L\",\n \"invoice\": \"Hpqc63wvE1ZjzeeH4kEycF\",\n \"reference\": \"Test refund\",\n \"status\": \"created\",\n \"amount\": 10,\n \"transactionCurrency\": \"BTC\",\n \"transactionAmount\": 0.000594,\n \"transactionRefundFee\": 0.000002,\n \"currency\": \"USD\",\n \"lastRefundNotification\": \"2021-08-29T20:45:35.368Z\",\n \"refundFee\": 0.04,\n \"immediate\": false,\n \"buyerPaysRefundFee\": false,\n \"requestDate\": \"2021-08-29T20:45:34.000Z\"\n }\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":false,"in":"header","ref":"","_id":"636c50f41dfbc5045d191021"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":false,"in":"header","ref":"","_id":"636c50f41dfbc5045d191020"},{"name":"guid","type":"string","enumValues":"","default":"","desc":"A variable provided by the merchant and designed to be used by the merchant to correlate the refund with a refund ID in their system.","required":false,"in":"path","ref":"","_id":"63757a865d284900961fddd9"},{"name":"token","type":"string","enumValues":"","default":"","desc":"When fetching a refund via the `merchant` facade, pass the API token as a URL parameter - the same token used to create the invoice in the first place.","required":true,"in":"query","ref":"","_id":"63757ae5a688f100e80977a1"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Retrieve a Refund by GUID Request","icon":"","type":"endpoint","slug":"retrieve-a-refund-by-guid-request","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716ab829c668003370bc56","createdAt":"2022-12-10T00:13:36.773Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]},{"_id":"63757b1311b33e054e15abd8","api":{"method":"get","url":"/refunds","auth":"never","results":{"codes":[{"name":"","code":"{\n \"data\": [\n {\n \"id\": \"WoE46gSLkJQS48RJEiNw3L\",\n \"invoice\": \"Hpqc63wvE1ZjzeeH4kEycF\",\n \"reference\": \"Test refund\",\n \"status\": \"canceled\",\n \"amount\": 5,\n \"transactionCurrency\": \"BTC\",\n \"transactionAmount\": 0.000297,\n \"transactionRefundFee\": 0.000001,\n \"currency\": \"USD\",\n \"lastRefundNotification\": \"2021-08-28T22:49:33.368Z\",\n \"refundFee\": 0.02,\n \"immediate\": false,\n \"buyerPaysRefundFee\": false,\n \"requestDate\": \"2021-08-28T22:49:33.000Z\"\n },\n {\n \"id\": \"WoE46gSLkJQS48RJEiNw3L\",\n \"invoice\": \"Hpqc63wvE1ZjzeeH4kEycF\",\n \"reference\": \"Test refund 2\",\n \"status\": \"created\",\n \"amount\": 10,\n \"transactionCurrency\": \"BTC\",\n \"transactionAmount\": 0.000594,\n \"transactionRefundFee\": 0.000002,\n \"currency\": \"USD\",\n \"lastRefundNotification\": \"2021-08-29T20:45:35.368Z\",\n \"refundFee\": 0.04,\n \"immediate\": false,\n \"buyerPaysRefundFee\": false,\n \"requestDate\": \"2021-08-29T20:45:34.000Z\"\n },\n ]\n}","language":"json","status":200}]},"params":[{"name":"invoiceId","type":"string","enumValues":"","default":"","desc":"The ID of the invoice of which the refunds are being requested.","required":true,"in":"query","ref":"","_id":"63757b3b1b63b4002b0e1aec"},{"name":"token","type":"string","enumValues":"","default":"","desc":"When fetching a refund via the `merchant` facade, pass the API token as a URL parameter - the same token used to create the invoice in the first place.","required":true,"in":"query","ref":"","_id":"63757ae5a688f100e80977a1"},{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":false,"in":"header","ref":"","_id":"636c50f41dfbc5045d191021"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":false,"in":"header","ref":"","_id":"636c50f41dfbc5045d191020"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Retrieve Refunds of an Invoice","icon":"","type":"endpoint","slug":"retrieve-refunds-of-an-invoice","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716ab829c668003370bc56","createdAt":"2022-11-17T00:06:43.909Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]},{"_id":"63757b83b9787600104bb07b","api":{"method":"delete","url":"/refunds/{refundId}","auth":"never","results":{"codes":[{"name":"","code":"{\n \"data\": {\n \"id\": \"WoE46gSLkJQS48RJEiNw3L\",\n \"invoice\": \"Hpqc63wvE1ZjzeeH4kEycF\",\n \"reference\": \"Test refund\",\n \"status\": \"cancelled\",\n \"amount\": 10,\n \"transactionCurrency\": \"BTC\",\n \"transactionAmount\": 0.000594,\n \"transactionRefundFee\": 0.000002,\n \"currency\": \"USD\",\n \"lastRefundNotification\": \"2021-08-29T20:45:35.368Z\",\n \"refundFee\": 0.04,\n \"immediate\": false,\n \"buyerPaysRefundFee\": false,\n \"requestDate\": \"2021-08-29T20:45:34.000Z\"\n }\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191021"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191020"},{"name":"refundId","type":"string","enumValues":"","default":"","desc":"The ID of the refund request for which you want to cancel.","required":false,"in":"path","ref":"","_id":"63757a865d284900961fddd9"},{"name":"token","type":"string","enumValues":"","default":"","desc":"When fetching a refund via the `merchant` facade, pass the API token as a URL parameter - the same token used to create the invoice in the first place.","required":true,"in":"query","ref":"","_id":"63757ae5a688f100e80977a1"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Cancel a Refund Request","icon":"","type":"endpoint","slug":"cancel-a-refund-request","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"cancel-a-refund","parentDoc":"63716ab829c668003370bc56","createdAt":"2022-11-17T00:08:35.908Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":false,"children":[]},{"_id":"6393cea3cd211a00127ef70b","api":{"method":"delete","url":"/refunds/guid/{guid}","auth":"never","results":{"codes":[{"name":"","code":"{\n \"data\": {\n \"id\": \"WoE46gSLkJQS48RJEiNw3L\",\n \"invoice\": \"Hpqc63wvE1ZjzeeH4kEycF\",\n \"reference\": \"Test refund\",\n \"status\": \"cancelled\",\n \"amount\": 10,\n \"transactionCurrency\": \"BTC\",\n \"transactionAmount\": 0.000594,\n \"transactionRefundFee\": 0.000002,\n \"currency\": \"USD\",\n \"lastRefundNotification\": \"2021-08-29T20:45:35.368Z\",\n \"refundFee\": 0.04,\n \"immediate\": false,\n \"buyerPaysRefundFee\": false,\n \"requestDate\": \"2021-08-29T20:45:34.000Z\"\n }\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191021"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191020"},{"name":"guid","type":"string","enumValues":"","default":"","desc":"A variable provided by the merchant and designed to be used by the merchant to correlate the refund with a refund ID in their system.","required":false,"in":"path","ref":"","_id":"63757a865d284900961fddd9"},{"name":"token","type":"string","enumValues":"","default":"","desc":"When fetching a refund via the `merchant` facade, pass the API token as a URL parameter - the same token used to create the invoice in the first place.","required":true,"in":"query","ref":"","_id":"63757ae5a688f100e80977a1"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Cancel a Refund by GUID Request","icon":"","type":"endpoint","slug":"cancel-a-refund-by-guid-request","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716ab829c668003370bc56","createdAt":"2022-12-10T00:11:15.289Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":false,"children":[]},{"_id":"63757c38f65e940065d10528","api":{"method":"post","url":"/refunds/{refundId}/notifications","auth":"never","results":{"codes":[{"name":"","code":"{\n \"status\": \"success\",\n \"data\": {},\n \"message\": null\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191021"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191020"},{"name":"refundId","type":"string","enumValues":"","default":"","desc":"The ID of the refund request for which you want to cancel.","required":false,"in":"path","ref":"","_id":"63757a865d284900961fddd9"},{"name":"token","type":"string","enumValues":"","default":"","desc":"The resource token for the `refundId` you want the notification to be resent. You first need to retrieve this token from the refund object itself, using the merchant facade (see section Retrieve a refund).","required":true,"in":"body","ref":"","_id":"63757c590c80ef0072fb33a4"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Request a Refund Notification to be Resent","icon":"","type":"endpoint","slug":"request-a-refund-notification-to-be-resent","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716ab829c668003370bc56","createdAt":"2022-11-17T00:11:36.454Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":false,"children":[]}]},{"_id":"63716ac31d58db000f48ba90","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Settlements","icon":"","type":"basic","slug":"settlements","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-13T22:08:03.350Z","category":"636c2e44f41a34006b3b0db2","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"63795ba7d75e4e001774e911","api":{"method":"get","url":"/settlements","auth":"required","results":{"codes":[{"name":"","code":"{\n \"facade\": \"merchant/settlement\",\n \"data\": [\n {\n \"id\": \"KBkdURgmE3Lsy9VTnavZHX\",\n \"accountId\": \"YJCgTf3jrXHkUVzLQ7y4eg\",\n \"status\": \"processing\",\n \"currency\": \"EUR\",\n \"payoutInfo\": {\n \"label\": \"Corporate account\",\n \"bankCountry\": \"Netherlands\",\n \"name\": \"Test Organization\",\n \"bank\": \"Test\",\n \"swift\": \"RABONL2U\",\n \"account\": \"NL85ABNA0000000000\"\n },\n \"dateCreated\": \"2021-05-10T09:05:00.176Z\",\n \"dateExecuted\": \"2021-05-10T11:52:29.681Z\",\n \"openingDate\": \"2021-05-09T09:00:00.000Z\",\n \"closingDate\": \"2021-05-10T09:00:00.000Z\",\n \"openingBalance\": 1.27,\n \"ledgerEntriesSum\": 20.82,\n \"withholdings\": [],\n \"withholdingsSum\": 0,\n \"totalAmount\": 22.09,\n \"token\": \"2gBtViSiBWSEJGo1LfaMFHoaBRzE2jek2VitKAYeenj2SRiTVSCgRvs1WTN8w4w8Lc\"\n },\n {\n \"id\": \"RPWTabW8urd3xWv2To989v\",\n \"accountId\": \"YJCgTf3jrXHkUVzLQ7y4eg\",\n \"status\": \"processing\",\n \"currency\": \"EUR\",\n \"payoutInfo\": {\n \"label\": \"Corporate account\",\n \"bankCountry\": \"Netherlands\",\n \"name\": \"Test Organization\",\n \"bank\": \"Test\",\n \"swift\": \"RABONL2U\",\n \"account\": \"NL85ABNA0000000000\"\n },\n \"dateCreated\": \"2021-05-11T09:05:00.176Z\",\n \"dateExecuted\": \"2021-05-11T11:52:29.681Z\",\n \"openingDate\": \"2021-05-10T09:00:00.000Z\",\n \"closingDate\": \"2021-05-11T09:00:00.000Z\",\n \"openingBalance\": 23.27,\n \"ledgerEntriesSum\": 20.82,\n \"withholdings\": [\n {\n \"amount\": 8.21,\n \"code\": \"W005\",\n \"description\": \"Pending Refunds\"\n }\n ],\n \"withholdingsSum\": 8.21,\n \"totalAmount\": 35.88,\n \"token\": \"2gBtViSiBWSEJitKAYSCgRvs1WTN8w4Go1Leenj2SRiTVFHoaBRzE2jek2VfaMw8Lc\"\n }\n ]\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374167755cb9c00294ec5f0"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374164ec038610040ebede4"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"6374168a18b64e007e759b80"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"637416dbf2ff62001097f3b1"},{"name":"token","type":"string","enumValues":"","default":"","desc":"When fetching settlememts, pass a merchant facade token as a URL parameter.","required":true,"in":"query","ref":"","_id":"63742d630b130c000fe8596b"},{"name":"dateStart","type":"string","enumValues":"","default":"","desc":"The start of the date window to query for settlements. Format YYYY-MM-DD","required":false,"in":"query","ref":"","_id":"63742e9cc3ba8e0059a7eef7"},{"name":"dateEnd","type":"string","enumValues":"","default":"","desc":"The end of the date window to query for settlements. Format YYYY-MM-DD","required":false,"in":"query","ref":"","_id":"63742e9cc3ba8e0059a7eef6"},{"name":"status","type":"string","enumValues":"","default":"","desc":"The settlement status you want to query on","required":false,"in":"query","ref":"","_id":"63742e9cc3ba8e0059a7eef5"},{"name":"currency","type":"string","enumValues":"","default":"","desc":"The settlement currency you want to query on","required":false,"in":"query","ref":"","_id":"63742ee62f2d230023e79276"},{"name":"limit","type":"int","enumValues":"","default":"","desc":"Maximum results that the query will return (useful for paging results)","required":false,"in":"query","ref":"","_id":"63742ee62f2d230023e79275"},{"name":"offset","type":"int","enumValues":"","default":"","desc":"Number of results to offset (ex. skip 10 will give you results starting with the 11th result)","required":false,"in":"query","ref":"","_id":"63742ee62f2d230023e79274"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Retrieve Settlements","icon":"","type":"endpoint","slug":"retrieve-settlements","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716ac31d58db000f48ba90","createdAt":"2022-11-19T22:41:43.168Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]},{"_id":"63795c2633ad9000a0167d3d","api":{"method":"get","url":"/settlements/{settlementId}","auth":"never","results":{"codes":[{"name":"","code":"{\n \"facade\": \"merchant/settlement\",\n \"data\": {\n \"id\": \"RPWTabW8urd3xWv2To989v\",\n \"accountId\": \"YJCgTf3jrXHkUVzLQ7y4eg\",\n \"status\": \"processing\",\n \"currency\": \"EUR\",\n \"payoutInfo\": {\n \"label\": \"Corporate account\",\n \"bankCountry\": \"Netherlands\",\n \"name\": \"Test Organization\",\n \"bank\": \"Test\",\n \"swift\": \"RABONL2U\",\n \"account\": \"NL85ABNA0000000000\"\n },\n \"dateCreated\": \"2021-05-11T09:05:00.176Z\",\n \"dateExecuted\": \"2021-05-11T11:52:29.681Z\",\n \"openingDate\": \"2021-05-10T09:00:00.000Z\",\n \"closingDate\": \"2021-05-11T09:00:00.000Z\",\n \"openingBalance\": 23.27,\n \"ledgerEntriesSum\": 20.82,\n \"withholdings\": [\n {\n \"amount\": 8.21,\n \"code\": \"W005\",\n \"description\": \"Pending Refunds\"\n }\n ],\n \"withholdingsSum\": 8.21,\n \"totalAmount\": 35.88,\n \"token\": \"2GrR6GDeYxUFYM9sDKViy6nFFTy4Rjvm1SYdLBjK46jkeJdgUTRccRfhtwkhNcuZky\"\n }\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191021"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191020"},{"name":"settlementId","type":"string","enumValues":"","default":"","desc":"ID of the specific settlement resource to be fetched","required":false,"in":"path","ref":"","_id":"63757a865d284900961fddd9"},{"name":"token","type":"string","enumValues":"","default":"","desc":"When fetching settlements, pass a merchant facade token as a URL parameter.","required":true,"in":"query","ref":"","_id":"63757ae5a688f100e80977a1"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Retrieve a Settlement","icon":"","type":"endpoint","slug":"retrieve-a-settlement","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716ac31d58db000f48ba90","createdAt":"2022-11-19T22:43:50.745Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]},{"_id":"63795d5b44736700a4228bc0","api":{"method":"get","url":"/settlements/{settlementId}/reconciliationreport","auth":"never","results":{"codes":[{"name":"","code":"{\n \"data\": {\n \"id\": \"RvNuCTMAkURKimwgvSVEMP\",\n \"accountId\": \"YJCgTf3jrXHkUVzLQ7y4eg\",\n \"status\": \"processing\",\n \"currency\": \"USD\",\n \"payoutInfo\": {\n \"label\": \"Test\",\n \"bankCountry\": \"Netherlands\",\n \"bankAddress\": \"test\",\n \"bankAddress2\": \"test\",\n \"bankName\": \"Test\",\n \"iban\": \"NL85ABNA0000000000\",\n \"swift\": \"RABONL2U\",\n \"accountHolderCountry\": \"United States\",\n \"accountHolderCity\": \"test\",\n \"accountHolderPostalCode\": \"test\",\n \"accountHolderAddress\": \"test\",\n \"accountHolderAddress2\": \"test\",\n \"accountHolderName\": \"test\",\n \"wire\": true\n },\n \"dateCreated\": \"2018-08-23T20:45:22.742Z\",\n \"dateExecuted\": \"2018-08-23T20:47:06.912Z\",\n \"openingDate\": \"2018-08-01T13:00:00.000Z\",\n \"closingDate\": \"2018-08-23T13:00:00.000Z\",\n \"openingBalance\": 23.13,\n \"ledgerEntriesSum\": 2956.77,\n \"withholdings\": [\n {\n \"amount\": 590.08,\n \"code\": \"W005\",\n \"description\": \"Pending Refunds\"\n }\n ],\n \"withholdingsSum\": 590.08,\n \"totalAmount\": 2389.82,\n \"ledgerEntries\": [\n {\n \"code\": 1000,\n \"description\": \"Test invoice BCH\",\n \"timestamp\": \"2018-08-01T20:16:03.742Z\",\n \"amount\": 5.83,\n \"invoiceId\": \"E1pJQNsHP2oHuMo2fagpe6\",\n \"invoiceData\": {\n \"orderId\": \"Test invoice BCH\",\n \"date\": \"2018-08-01T19:24:42.789Z\",\n \"price\": 5,\n \"currency\": \"EUR\",\n \"transactionCurrency\": \"BCH\",\n \"payoutPercentage\": {\n \"USD\": 100\n }\n }\n },\n {\n \"code\": 1023,\n \"description\": \"Invoice Fee\",\n \"timestamp\": \"2018-08-01T20:16:03.742Z\",\n \"amount\": -0.06,\n \"invoiceId\": \"E1pJQNsHP2oHuMo2fagpe6\"\n },\n {\n \"code\": 1017,\n \"description\": \"Account Settlement XGJqZmdSGDwi5exXqQusJf\",\n \"timestamp\": \"2018-08-01T20:19:54.394Z\",\n \"amount\": -23.13\n },\n {\n \"code\": 1000,\n \"description\": \"Test invoice BCH\",\n \"timestamp\": \"2018-08-01T20:20:25.258Z\",\n \"amount\": 5.84,\n \"invoiceId\": \"PbPTukHvymCZYA8FGDa5wh\",\n \"invoiceData\": {\n \"orderId\": \"Test invoice BCH\",\n \"date\": \"2018-08-01T19:37:52.790Z\",\n \"price\": 5,\n \"currency\": \"EUR\",\n \"transactionCurrency\": \"BCH\",\n \"payoutPercentage\": {\n \"USD\": 100\n }\n }\n },\n {\n \"code\": 1023,\n \"description\": \"Invoice Fee\",\n \"timestamp\": \"2018-08-01T20:20:25.258Z\",\n \"amount\": -0.06,\n \"invoiceId\": \"PbPTukHvymCZYA8FGDa5wh\"\n },\n {\n \"code\": 1000,\n \"description\": \"Bill 2\",\n \"timestamp\": \"2018-08-02T13:54:16.656Z\",\n \"amount\": 1010.1,\n \"invoiceId\": \"GfcuUrvc2TAeCdSzAupbe8\",\n \"invoiceData\": {\n \"orderId\": \"Bill 2\",\n \"date\": \"2018-08-02T12:11:15.760Z\",\n \"price\": 1010.1,\n \"currency\": \"USD\",\n \"transactionCurrency\": \"BTC\",\n \"payoutPercentage\": {\n \"USD\": 100\n }\n }\n },\n {\n \"code\": 1023,\n \"description\": \"Invoice Fee\",\n \"timestamp\": \"2018-08-02T13:54:16.656Z\",\n \"amount\": -10.1,\n \"invoiceId\": \"GfcuUrvc2TAeCdSzAupbe8\"\n },\n {\n \"code\": 1000,\n \"description\": \"Bill 2\",\n \"timestamp\": \"2018-08-02T13:54:16.663Z\",\n \"amount\": 1010.1,\n \"invoiceId\": \"C3ak5sJD3k15nxTePgVYBv\",\n \"invoiceData\": {\n \"orderId\": \"Bill 2\",\n \"date\": \"2018-08-02T12:01:44.613Z\",\n \"price\": 1010.1,\n \"currency\": \"USD\",\n \"transactionCurrency\": \"BTC\",\n \"payoutPercentage\": {\n \"USD\": 100\n }\n }\n },\n {\n \"code\": 1023,\n \"description\": \"Invoice Fee\",\n \"timestamp\": \"2018-08-02T13:54:16.663Z\",\n \"amount\": -10.1,\n \"invoiceId\": \"C3ak5sJD3k15nxTePgVYBv\"\n },\n {\n \"code\": 1000,\n \"description\": \"Test bill 1\",\n \"timestamp\": \"2018-08-03T10:15:39.714Z\",\n \"amount\": 1311.81,\n \"invoiceId\": \"5Bfnr8eamNCAYjhVYfzJxs\",\n \"invoiceData\": {\n \"orderId\": \"Test bill 1\",\n \"date\": \"2018-08-03T09:22:55.518Z\",\n \"price\": 1010.1,\n \"currency\": \"GBP\",\n \"transactionCurrency\": \"BTC\",\n \"payoutPercentage\": {\n \"USD\": 100\n }\n }\n },\n {\n \"code\": 1023,\n \"description\": \"Invoice Fee\",\n \"timestamp\": \"2018-08-03T10:15:39.714Z\",\n \"amount\": -13.12,\n \"invoiceId\": \"5Bfnr8eamNCAYjhVYfzJxs\"\n },\n {\n \"code\": 1000,\n \"description\": \"test bill\",\n \"timestamp\": \"2018-08-06T13:41:58.036Z\",\n \"amount\": 1010.1,\n \"invoiceId\": \"RMUkvBHVQnr9wLDHgD646u\",\n \"invoiceData\": {\n \"orderId\": \"test bill\",\n \"date\": \"2018-08-06T13:24:43.826Z\",\n \"price\": 1010.1,\n \"currency\": \"USD\",\n \"transactionCurrency\": \"BTC\",\n \"payoutPercentage\": {\n \"USD\": 100\n }\n }\n },\n {\n \"code\": 1023,\n \"description\": \"Invoice Fee\",\n \"timestamp\": \"2018-08-06T13:41:58.036Z\",\n \"amount\": -10.1,\n \"invoiceId\": \"RMUkvBHVQnr9wLDHgD646u\"\n },\n {\n \"code\": 1020,\n \"description\": \"Invoice Refund\",\n \"timestamp\": \"2018-08-07T08:34:49.842Z\",\n \"amount\": -1010.1,\n \"invoiceId\": \"RMUkvBHVQnr9wLDHgD646u\",\n \"invoiceData\": {\n \"orderId\": \"test bill\",\n \"date\": \"2018-08-06T13:24:43.826Z\",\n \"price\": 1010.1,\n \"currency\": \"USD\",\n \"transactionCurrency\": \"BTC\",\n \"payoutPercentage\": {\n \"USD\": 100\n },\n \"refundInfo\": {\n \"supportRequest\": \"Cw4dQ1wnEaL11EkfLrBQAC\",\n \"currency\": \"USD\",\n \"amounts\": {\n \"USD\": 1010.1,\n \"BTC\": 0.145439\n }\n }\n }\n },\n {\n \"code\": 1039,\n \"description\": \"Refund Fee\",\n \"timestamp\": \"2018-08-07T08:34:49.842Z\",\n \"amount\": -0.92\n },\n {\n \"code\": 1000,\n \"description\": \"Test invoice BCH\",\n \"timestamp\": \"2018-08-07T10:06:35.804Z\",\n \"amount\": 5.8,\n \"invoiceId\": \"LWgqvm3CH47psfgy83DvLX\",\n \"invoiceData\": {\n \"orderId\": \"Test invoice BCH\",\n \"date\": \"2018-08-07T09:14:09.106Z\",\n \"price\": 5,\n \"currency\": \"EUR\",\n \"transactionCurrency\": \"BCH\",\n \"payoutPercentage\": {\n \"USD\": 100\n }\n }\n },\n {\n \"code\": 1023,\n \"description\": \"Invoice Fee\",\n \"timestamp\": \"2018-08-07T10:06:35.804Z\",\n \"amount\": -0.06,\n \"invoiceId\": \"LWgqvm3CH47psfgy83DvLX\"\n },\n {\n \"code\": 1000,\n \"description\": \"Test invoice BCH\",\n \"timestamp\": \"2018-08-08T12:52:29.384Z\",\n \"amount\": 3.43,\n \"invoiceId\": \"932QfiTCd4ALwaLfqxH5ae\",\n \"invoiceData\": {\n \"orderId\": \"Test invoice BCH\",\n \"date\": \"2018-08-08T12:40:00.622Z\",\n \"price\": 2.96,\n \"currency\": \"EUR\",\n \"transactionCurrency\": \"BTC\",\n \"payoutPercentage\": {\n \"USD\": 100\n }\n }\n },\n {\n \"code\": 1023,\n \"description\": \"Invoice Fee\",\n \"timestamp\": \"2018-08-08T12:52:29.384Z\",\n \"amount\": -0.03,\n \"invoiceId\": \"932QfiTCd4ALwaLfqxH5ae\"\n },\n {\n \"code\": 1011,\n \"timestamp\": \"2018-08-09T13:04:49.607Z\",\n \"amount\": -340.19\n },\n {\n \"code\": 1011,\n \"timestamp\": \"2018-08-13T14:14:25.311Z\",\n \"amount\": -1.06\n },\n {\n \"code\": 1011,\n \"timestamp\": \"2018-08-13T14:15:09.605Z\",\n \"amount\": -1.33\n },\n {\n \"code\": 1011,\n \"timestamp\": \"2018-08-13T14:15:18.557Z\",\n \"amount\": -1.06\n },\n {\n \"code\": 1034,\n \"description\": \"PayoutRequest TDZZuBiqnsNnLjaX93ydcb\",\n \"timestamp\": \"2018-08-13T14:17:01.081Z\",\n \"amount\": -1\n },\n {\n \"code\": 1040,\n \"description\": \"Payout Fee\",\n \"timestamp\": \"2018-08-13T14:17:01.081Z\",\n \"amount\": -0.01\n },\n {\n \"code\": 1011,\n \"timestamp\": \"2018-08-13T14:17:21.617Z\",\n \"amount\": -1.11\n },\n {\n \"code\": 1011,\n \"timestamp\": \"2018-08-13T14:17:30.296Z\",\n \"amount\": -1.29\n },\n {\n \"code\": 1011,\n \"timestamp\": \"2018-08-13T14:29:52.473Z\",\n \"amount\": -1.09\n },\n {\n \"code\": 1034,\n \"description\": \"PayoutRequest BhKWi3WPSoGmCQfvvzfV9B\",\n \"timestamp\": \"2018-08-14T10:34:39.372Z\",\n \"amount\": -3000\n },\n {\n \"code\": 1040,\n \"description\": \"Payout Fee\",\n \"timestamp\": \"2018-08-14T10:34:39.372Z\",\n \"amount\": -30\n },\n {\n \"code\": 1011,\n \"timestamp\": \"2018-08-14T10:34:39.434Z\",\n \"amount\": 69.78\n },\n {\n \"code\": 1000,\n \"description\": \"Test invoice\",\n \"timestamp\": \"2018-08-14T11:13:38.374Z\",\n \"amount\": 582.49,\n \"invoiceId\": \"WxY7d2qUzJawZTTqpXUHov\",\n \"invoiceData\": {\n \"orderId\": \"Test invoice\",\n \"date\": \"2018-08-14T10:32:11.015Z\",\n \"price\": 1000,\n \"currency\": \"BGN\",\n \"transactionCurrency\": \"BCH\",\n \"payoutPercentage\": {\n \"USD\": 100\n }\n }\n },\n {\n \"code\": 1023,\n \"description\": \"Invoice Fee\",\n \"timestamp\": \"2018-08-14T11:13:38.374Z\",\n \"amount\": -5.82,\n \"invoiceId\": \"WxY7d2qUzJawZTTqpXUHov\"\n },\n {\n \"code\": 1000,\n \"description\": \"Test invoice\",\n \"timestamp\": \"2018-08-14T11:22:12.577Z\",\n \"amount\": 3000,\n \"invoiceId\": \"76ZQGxLuKwKJ5vBMvjdAbh\",\n \"invoiceData\": {\n \"orderId\": \"Test invoice\",\n \"date\": \"2018-08-14T10:37:06.348Z\",\n \"price\": 3000,\n \"currency\": \"USD\",\n \"transactionCurrency\": \"BTC\",\n \"payoutPercentage\": {\n \"USD\": 100\n }\n }\n },\n {\n \"code\": 1023,\n \"description\": \"Invoice Fee\",\n \"timestamp\": \"2018-08-14T11:22:12.577Z\",\n \"amount\": -30,\n \"invoiceId\": \"76ZQGxLuKwKJ5vBMvjdAbh\"\n },\n {\n \"code\": 1034,\n \"description\": \"PayoutRequest NkdbgovhHE8CED1ogUJ9Yg\",\n \"timestamp\": \"2018-08-14T11:45:08.017Z\",\n \"amount\": -4502\n },\n {\n \"code\": 1040,\n \"description\": \"Payout Fee\",\n \"timestamp\": \"2018-08-14T11:45:08.017Z\",\n \"amount\": -45.02\n },\n {\n \"code\": 1011,\n \"timestamp\": \"2018-08-14T11:45:08.073Z\",\n \"amount\": 1000.35\n },\n {\n \"code\": 1000,\n \"description\": \"Test invoice\",\n \"timestamp\": \"2018-08-14T13:10:18.890Z\",\n \"amount\": 3000,\n \"invoiceId\": \"RSPnAH9L5yDWUFNYTGDJmi\",\n \"invoiceData\": {\n \"orderId\": \"Test invoice\",\n \"date\": \"2018-08-14T11:58:30.028Z\",\n \"price\": 3000,\n \"currency\": \"USD\",\n \"transactionCurrency\": \"BTC\",\n \"payoutPercentage\": {\n \"USD\": 100\n }\n }\n },\n {\n \"code\": 1023,\n \"description\": \"Invoice Fee\",\n \"timestamp\": \"2018-08-14T13:10:18.890Z\",\n \"amount\": -30,\n \"invoiceId\": \"RSPnAH9L5yDWUFNYTGDJmi\"\n },\n {\n \"code\": 1000,\n \"description\": \"Iphone-Order 1\",\n \"timestamp\": \"2018-08-16T13:32:23.205Z\",\n \"amount\": 10,\n \"invoiceId\": \"WwCouQindnn6TYW9PvRMSU\",\n \"invoiceData\": {\n \"orderId\": \"Iphone-Order 1\",\n \"date\": \"2018-08-16T12:01:32.513Z\",\n \"price\": 10,\n \"currency\": \"USD\",\n \"transactionCurrency\": \"BTC\",\n \"payoutPercentage\": {\n \"USD\": 100\n }\n }\n },\n {\n \"code\": 1023,\n \"description\": \"Invoice Fee\",\n \"timestamp\": \"2018-08-16T13:32:23.205Z\",\n \"amount\": -0.1,\n \"invoiceId\": \"WwCouQindnn6TYW9PvRMSU\"\n }\n ]\n }\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191021"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191020"},{"name":"settlementId","type":"string","enumValues":"","default":"","desc":"ID of the specific settlement resource to be fetched","required":false,"in":"path","ref":"","_id":"63757a865d284900961fddd9"},{"name":"token","type":"string","enumValues":"","default":"","desc":"When fetching the reconciliation report for a specific settlement, use the API token linked to the corresponding settlement resource. This token can be retrieved via the endpoint `GET https://bitpay.com/settlements/{settlementId}.","required":true,"in":"query","ref":"","_id":"63757ae5a688f100e80977a1"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Fetch a Reconciliation Report","icon":"","type":"endpoint","slug":"fetch-a-reconciliation-report","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716ac31d58db000f48ba90","createdAt":"2022-11-19T22:48:59.722Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":false,"children":[]}]},{"_id":"63716ac99213ce003071a170","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Ledgers","icon":"","type":"basic","slug":"ledgers","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-13T22:08:09.320Z","category":"636c2e44f41a34006b3b0db2","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"63795f68409410000fb4b0af","api":{"method":"get","url":"/ledgers","auth":"required","results":{"codes":[{"name":"","code":"{\n \"data\": [\n {\n \"currency\": \"EUR\",\n \"balance\": 0\n },\n {\n \"currency\": \"USD\",\n \"balance\": 2389.82\n },\n {\n \"currency\": \"BTC\",\n \"balance\": 0.000287\n }\n ]\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374167755cb9c00294ec5f0"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374164ec038610040ebede4"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"6374168a18b64e007e759b80"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"637416dbf2ff62001097f3b1"},{"name":"token","type":"string","enumValues":"","default":"","desc":"When fetching ledger entries, pass a merchant facade token as a URL parameter.","required":true,"in":"query","ref":"","_id":"63742d630b130c000fe8596b"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Retrieve Account Balances","icon":"","type":"endpoint","slug":"retrieve-account-balances","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716ac99213ce003071a170","createdAt":"2022-11-19T22:57:44.591Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":false,"children":[]},{"_id":"63795ffdce9025002cc8efc8","api":{"method":"get","url":"/ledgers/{currency}","auth":"required","results":{"codes":[{"name":"","code":"[\n {\n \"type\": \"Invoice\",\n \"amount\": 823000000,\n \"code\": 1000,\n \"description\": \"20210510_fghij\",\n \"timestamp\": \"2021-05-10T20:08:52.919Z\",\n \"txType\": \"sale\",\n \"scale\": 100000000,\n \"invoiceId\": \"Hpqc63wvE1ZjzeeH4kEycF\",\n \"buyerFields\": {\n \"buyerName\": \"John Doe\",\n \"buyerAddress1\": \"2630 Hegal Place\",\n \"buyerAddress2\": \"Apt 42\",\n \"buyerCity\": \"Alexandria\",\n \"buyerState\": \"VA\",\n \"buyerZip\": \"23242\",\n \"buyerCountry\": \"US\",\n \"buyerPhone\": \"555-123-456\",\n \"buyerNotify\": true,\n \"buyerEmail\": \"john@doe.com\"\n },\n \"invoiceAmount\": 10,\n \"invoiceCurrency\": \"USD\",\n \"transactionCurrency\": \"BCH\",\n \"id\": \"FR4rgfADCRNmAhtz1Ci4kU\"\n },\n {\n \"type\": \"Invoice Fee\",\n \"amount\": -8000000,\n \"code\": 1023,\n \"description\": \"Invoice Fee\",\n \"timestamp\": \"2021-05-10T20:08:52.919Z\",\n \"txType\": \"Invoice Fee\",\n \"scale\": 100000000,\n \"invoiceId\": \"Hpqc63wvE1ZjzeeH4kEycF\",\n \"buyerFields\": {\n \"buyerName\": \"John Doe\",\n \"buyerAddress1\": \"2630 Hegal Place\",\n \"buyerAddress2\": \"Apt 42\",\n \"buyerCity\": \"Alexandria\",\n \"buyerState\": \"VA\",\n \"buyerZip\": \"23242\",\n \"buyerCountry\": \"US\",\n \"buyerPhone\": \"555-123-456\",\n \"buyerNotify\": true,\n \"buyerEmail\": \"john@doe.com\"\n },\n \"invoiceAmount\": 10,\n \"invoiceCurrency\": \"USD\",\n \"transactionCurrency\": \"BCH\",\n \"id\": \"XCkhgHKP2pSme4qszMpM3B\"\n },\n {\n \"type\": \"Invoice Refund\",\n \"supportRequest\": \"SYyrnbRCJ78V1DknHakKPo\",\n \"amount\": -823000000,\n \"code\": 1020,\n \"description\": \"Invoice Refund\",\n \"timestamp\": \"2021-05-12T13:00:45.063Z\",\n \"txType\": \"Invoice Refund\",\n \"scale\": 100000000,\n \"invoiceId\": \"Hpqc63wvE1ZjzeeH4kEycF\",\n \"buyerFields\": {\n \"buyerName\": \"John Doe\",\n \"buyerAddress1\": \"2630 Hegal Place\",\n \"buyerAddress2\": \"Apt 42\",\n \"buyerCity\": \"Alexandria\",\n \"buyerState\": \"VA\",\n \"buyerZip\": \"23242\",\n \"buyerCountry\": \"US\",\n \"buyerPhone\": \"555-123-456\",\n \"buyerNotify\": true,\n \"buyerEmail\": \"john@doe.com\"\n },\n \"invoiceAmount\": 10,\n \"invoiceCurrency\": \"USD\",\n \"transactionCurrency\": \"BCH\",\n \"id\": \"PBqakmWMZ2H3RwhGq9vCsg\"\n }\n]","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374167755cb9c00294ec5f0"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374164ec038610040ebede4"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"6374168a18b64e007e759b80"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"637416dbf2ff62001097f3b1"},{"name":"token","type":"string","enumValues":"","default":"","desc":"When fetching ledger entries, pass a merchant facade token as a URL parameter.","required":true,"in":"query","ref":"","_id":"63742d630b130c000fe8596b"},{"name":"startDate","type":"string","enumValues":"","default":"","desc":"The start date for fetching ledger entries. Format YYYY-MM-DD","required":true,"in":"query","ref":"","_id":"6379602f0c72e5000f81ebdc"},{"name":"currency","type":"string","enumValues":"","default":"","desc":"ISO 4217 3-character currency code for your merchant account","required":false,"in":"path","ref":"","_id":"6379602f0c72e5000f81ebdb"},{"name":"endDate","type":"string","enumValues":"","default":"","desc":"The end date for fetching ledger entries. Format YYYY-MM-DD","required":true,"in":"query","ref":"","_id":"6379602f0c72e5000f81ebda"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Retrieve Ledger Entries","icon":"","type":"endpoint","slug":"retrieve-ledger-entries","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716ac99213ce003071a170","createdAt":"2022-11-19T23:00:13.392Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":false,"children":[]}]},{"_id":"63716ad1c2237d00248ea6c8","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Recipients","icon":"","type":"basic","slug":"recipients","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-13T22:08:17.447Z","category":"636c2e44f41a34006b3b0db2","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"637962fa34be200098fcb186","api":{"method":"post","url":"/recipients","auth":"never","results":{"codes":[{"name":"","code":"{\n \"facade\": \"payout/recipient\",\n \"data\": [\n {\n \"email\": \"alice@email.com\",\n \"label\": \"Alice\",\n \"status\": \"invited\",\n \"id\": \"JA4cEtmBxCp5cybtnh1rds\",\n \"shopperId\": null,\n \"token\": \"2LVBntm7z92rnuVjVX5ZVaDoUEaoY4LxhZMMzPAMGyXcejgPXVmZ4Ae3oGaCGBFKQf\"\n },\n {\n \"email\": \"bob@email.com\",\n \"label\": \"Bob\",\n \"status\": \"invited\",\n \"id\": \"X3icwc4tE8KJ5hEPNPpDXW\",\n \"shopperId\": null,\n \"token\": \"2LVBntm7z92rnuVjVX5ZVaDoUEaoY4LxhZMMzPAMGyXrrBAB9vRY3BVxGLbAa6uEx7\"\n }\n ]\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191021"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191020"},{"name":"recipients","type":"array_object","enumValues":"","default":"","desc":"Array of JSON objects made of the following parameters. Merchants can invite several recipients in one batch call.","required":true,"in":"body","ref":"recipient","_id":"63796352abd18c001675f34c"},{"name":"token","type":"string","enumValues":"","default":"","desc":"Approved payout facade token.","required":true,"in":"body","ref":"","_id":"637963b29af8e900490f349d"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Invite Recipients","icon":"","type":"endpoint","slug":"invite-recipients","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716ad1c2237d00248ea6c8","createdAt":"2022-11-19T23:12:58.988Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":false,"children":[]},{"_id":"637963d6baf1f2002b991690","api":{"method":"get","url":"/recipients/{recipientId}","auth":"required","results":{"codes":[{"name":"","code":"{\n \"facade\": \"payout/recipient\",\n \"data\": {\n \"email\": \"john.smith@email.com\",\n \"label\": \"John Smith\",\n \"status\": \"invited\",\n \"id\": \"JA4cEtmBxCp5cybtnh1rds\",\n \"shopperId\": null,\n \"token\": \"2LVBntm7z92rnuVjVX5ZVaDoUEaoY4LxhZMMzPAMGyXcejgPXVmZ4Ae3oGaCGBFKQf\"\n }\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374167755cb9c00294ec5f0"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374164ec038610040ebede4"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"6374168a18b64e007e759b80"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"637416dbf2ff62001097f3b1"},{"name":"token","type":"string","enumValues":"","default":"","desc":"Approved payout facade token.","required":true,"in":"query","ref":"","_id":"63742d630b130c000fe8596b"},{"name":"recipientId","type":"string","enumValues":"","default":"","desc":"The id of the payout recipient you want to retrieve.","required":false,"in":"path","ref":"","_id":"6379602f0c72e5000f81ebdb"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Retrieve a Recipient","icon":"","type":"endpoint","slug":"retrieve-a-recipient","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716ad1c2237d00248ea6c8","createdAt":"2022-11-19T23:16:38.870Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]},{"_id":"637964271f3b050062a6f660","api":{"method":"put","url":"/recipients/{recipientId}","auth":"required","results":{"codes":[{"name":"","code":"{\n \"facade\": \"payout/recipient\",\n \"data\": {\n \"email\": \"bob@email.com\",\n \"label\": \"Bob123\",\n \"status\": \"invited\",\n \"id\": \"X3icwc4tE8KJ5hEPNPpDXW\",\n \"shopperId\": null,\n \"token\": \"2LVBntm7z92rnuVjVX5ZVaDoUEaoY4LxhZMMzPAMGyXrrBAB9vRY3BVxGLbAa6uEx7\"\n }\n}","language":"json","status":200}]},"params":[{"name":"recipientId","type":"string","enumValues":"","default":"","desc":"The id of the payout recipient you want to retrieve.","required":false,"in":"path","ref":"","_id":"6379602f0c72e5000f81ebdb"},{"name":"label","type":"string","enumValues":"","default":"","desc":"For merchant use, pass through - could be customer name or unique reference.","required":false,"in":"query","ref":"","_id":"6379643fd4c5f700403dfd69"},{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374167755cb9c00294ec5f0"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374164ec038610040ebede4"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"6374168a18b64e007e759b80"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"637416dbf2ff62001097f3b1"},{"name":"token","type":"string","enumValues":"","default":"","desc":"Approved payout facade token.","required":true,"in":"body","ref":"","_id":"637a89e66fd87200324032f1"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Update a Recipient","icon":"","type":"endpoint","slug":"update-a-recipient","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716ad1c2237d00248ea6c8","createdAt":"2022-11-19T23:17:59.680Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]},{"_id":"63796464fad85a002c35ddb3","api":{"method":"delete","url":"/recipients/{recipientId}","auth":"required","results":{"codes":[{"name":"","code":"{\n \"status\": \"success\",\n \"data\": {},\n \"message\": null\n}","language":"json","status":200}]},"params":[{"name":"recipientId","type":"string","enumValues":"","default":"","desc":"The id of the payout recipient you want to remove.","required":false,"in":"path","ref":"","_id":"6379602f0c72e5000f81ebdb"},{"name":"token","type":"string","enumValues":"","default":"","desc":"Approved payout facade token.","required":true,"in":"query","ref":"","_id":"63742d630b130c000fe8596b"},{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374167755cb9c00294ec5f0"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374164ec038610040ebede4"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"6374168a18b64e007e759b80"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"637416dbf2ff62001097f3b1"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Remove a Recipient","icon":"","type":"endpoint","slug":"remove-a-recipient","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716ad1c2237d00248ea6c8","createdAt":"2022-11-19T23:19:00.540Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":false,"children":[]},{"_id":"637964d6e3599e004f74e297","api":{"method":"get","url":"/recipients","auth":"required","results":{"codes":[{"name":"","code":"{\n \"facade\": \"payout/recipient\",\n \"data\": [\n {\n \"email\": \"alice@email.com\",\n \"label\": \"Alice\",\n \"status\": \"invited\",\n \"id\": \"JA4cEtmBxCp5cybtnh1rds\",\n \"shopperId\": null,\n \"token\": \"2LVBntm7z92rnuVjVX5ZVaDoUEaoY4LxhZMMzPAMGyXcejgPXVmZ4Ae3oGaCGBFKQf\"\n },\n {\n \"email\": \"bob@email.com\",\n \"label\": \"Bob\",\n \"status\": \"invited\",\n \"id\": \"X3icwc4tE8KJ5hEPNPpDXW\",\n \"shopperId\": null,\n \"token\": \"2LVBntm7z92rnuVjVX5ZVaDoUEaoY4LxhZMMzPAMGyXrrBAB9vRY3BVxGLbAa6uEx7\"\n }\n ]\n}","language":"json","status":200}]},"params":[{"name":"token","type":"string","enumValues":"","default":"","desc":"Approved payout facade token.","required":true,"in":"query","ref":"","_id":"63742d630b130c000fe8596b"},{"name":"status","type":"string","enumValues":"","default":"","desc":"The recipient status you want to query on. Possible status options are `invited`, `unverified`, `verified`, and `active`.","required":false,"in":"query","ref":"","_id":"63796586d3176b001e4bfbd4"},{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374167755cb9c00294ec5f0"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374164ec038610040ebede4"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"6374168a18b64e007e759b80"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"637416dbf2ff62001097f3b1"},{"name":"limit","type":"int","enumValues":"","default":"","desc":"Maximum results that the query will return (useful for paging results).","required":false,"in":"query","ref":"","_id":"63796586d3176b001e4bfbcf"},{"name":"offset","type":"int","enumValues":"","default":"","desc":"Number of results to offset (ex. skip 10 will give you results starting with the 11th result).","required":false,"in":"query","ref":"","_id":"63796586d3176b001e4bfbce"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Retrieve Recipients by Status","icon":"","type":"endpoint","slug":"retrieve-recipients-by-status","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716ad1c2237d00248ea6c8","createdAt":"2022-11-19T23:20:54.959Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]},{"_id":"637966c55e5e61006da66d10","api":{"method":"post","url":"/recipients/{recipientId}/notifications","auth":"never","results":{"codes":[{"name":"","code":"{\n \"status\": \"success\",\n \"data\": {},\n \"message\": null\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191021"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191020"},{"name":"recipientId","type":"string","enumValues":"","default":"","desc":"The id of the recipient for which you want the last webhook to be resent.","required":false,"in":"path","ref":"","_id":"63757a865d284900961fddd9"},{"name":"token","type":"string","enumValues":"","default":"","desc":"Approved payout facade token.","required":true,"in":"body","ref":"","_id":"63757c590c80ef0072fb33a4"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Request a Recipient Webhook to be Resent","icon":"","type":"endpoint","slug":"request-a-recipient-webhook-to-be-resent","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716ad1c2237d00248ea6c8","createdAt":"2022-11-19T23:29:09.658Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":false,"children":[]}]},{"_id":"63716adb1ae0f70033007743","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Payouts","icon":"","type":"basic","slug":"payouts","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-13T22:08:27.749Z","category":"636c2e44f41a34006b3b0db2","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"637a7b644e19e8009eb96386","api":{"method":"post","url":"/payouts","auth":"never","results":{"codes":[{"name":"","code":"{\n \"facade\": \"payout/payout\",\n \"data\": {\n \"id\": \"JMwv8wQCXANoU2ZZQ9a9GH\",\n \"recipientId\": \"LDxRZCGq174SF8AnQpdBPB\",\n \"accountId\": \"SJcWZCFq344DL8QnXpdBNM\",\n \"shopperId\": \"7qohDf2zZnQK5Qanj8oyC2\",\n \"amount\": 10,\n \"currency\": \"USD\",\n \"ledgerCurrency\": \"GBP\",\n \"email\": \"john@doe.com\",\n \"reference\": \"payout_20210527\",\n \"label\": \"John Doe\",\n \"notificationURL\": \"https://yournotiticationURL.com/wed3sa0wx1rz5bg0bv97851eqx\",\n \"notificationEmail\": \"merchant@email.com\",\n \"effectiveDate\": \"2021-05-27T09:00:00.000Z\",\n \"requestDate\": \"2021-05-27T10:47:37.834Z\",\n \"status\": \"new\",\n \"transactions\": [],\n \"token\": \"6RZSTPtnzEaroAe2X4YijenRiqteRDNvzbT8NjtcHjUVd9FUFwa7dsX8RFgRDDC5SL\"\n },\n \"status\": \"success\",\n \"message\": null\n}","language":"json","status":200}]},"params":[{"name":"amount","type":"double","enumValues":"","default":"","desc":"The payout amount in the requested `currency`. The minimum amount per instruction is **$5 USD** equivalent.","required":true,"in":"body","ref":"","_id":"63796352abd18c001675f34c"},{"name":"currency","type":"string","enumValues":"","default":"","desc":"Currency code set for the payout amount (ISO 4217 3-character currency code).","required":true,"in":"body","ref":"","_id":"637963b29af8e900490f349d"},{"name":"ledgerCurrency","type":"string","enumValues":"","default":"","desc":"Ledger currency code set for the payout (ISO 4217 3-character currency code), it indicates on which ledger the payout will be recorded. Supported ledger currency codes for payouts are EUR, USD, GBP, CAD, NZD, AUD, ZAR, JPY, BTC, BCH, GUSD, USDC, PAX, XRP, BUSD, DOGE, ETH, WBTC, DAI.","required":true,"in":"body","ref":"","_id":"637a7c163844840801312cfa"},{"name":"reference","type":"string","enumValues":"","default":"","desc":"Present only if specified by the merchant in the request. Merchants can pass their own unique identifier in this field for reconciliation purposes or for querying. Maximum string length is 100 characters.","required":false,"in":"body","ref":"","_id":"637a7c163844840801312cf9"},{"name":"notificationEmail","type":"string","enumValues":"","default":"","desc":"Merchant email address for notification of payout status change.","required":false,"in":"body","ref":"","_id":"637a7c163844840801312cf8"},{"name":"notificationURL","type":"string","enumValues":"","default":"","desc":"URL to which BitPay sends webhook notifications. If a notificationURL is not passed, the payout will default to using the merchant account level payout IPN if populated. This can be set by the following flow: Settings > General > Payout Settings > Payout IPN. HTTPS is mandatory.","required":false,"in":"body","ref":"","_id":"637a7c163844840801312cf7"},{"name":"email","type":"string","enumValues":"","default":"","desc":"Email address of a recipient. If the recipient email is not found, the recipient will be invited as well. <br/><br/>Note: In the future, BitPay may allow Recipients to update the email address tied to their personal account. BitPay encourages the use of recipientId or shopperId when programmatically creating payouts.","required":false,"in":"body","ref":"","_id":"637a7c163844840801312cf6"},{"name":"recipientId","type":"string","enumValues":"","default":"","desc":"Bitpay recipient id of an active recipient, assigned by BitPay for a given recipient email during the onboarding process (see Recipients resource).","required":false,"in":"body","ref":"","_id":"637a7c807f44ac008f4d3fb2"},{"name":"shopperId","type":"string","enumValues":"","default":"","desc":"This is the unique id assigned by BitPay if the shopper used their personal BitPay account to authenticate and pay an invoice. For customers signing up for a brand new BitPay personal account, this id will only be created as part of the payout onboarding.<br/><br/>The same field would also be available on paid invoices if the customer signed in with their BitPay personal account before completing the payment. This can allow merchants to monitor the activity of a customer (deposits & payouts).","required":false,"in":"body","ref":"","_id":"637a7c807f44ac008f4d3fb1"},{"name":"label","type":"string","enumValues":"","default":"","desc":"For merchant use, pass through - can be the customer name or unique merchant reference assigned by the merchant to to the recipient.","required":false,"in":"body","ref":"","_id":"637a7c807f44ac008f4d3fb0"},{"name":"effectiveDate","type":"string","enumValues":"","default":"","desc":"Effective date and time (UTC) for the payout. ISO-8601 date format `yyyy-mm-dd`. If not provided, defaults to date and time of creation.","required":false,"in":"body","ref":"","_id":"637a7c807f44ac008f4d3faf"},{"name":"ignoreEmails","type":"boolean","enumValues":"","default":"","desc":"Boolean to prevent email updates on a specific payout. Defaults to false if not provided - you will receive emails unless specified to true.","required":false,"in":"body","ref":"","_id":"637a7c807f44ac008f4d3fae"},{"name":"token","type":"string","enumValues":"","default":"","desc":"Approved payout facade token.","required":true,"in":"body","ref":"","_id":"637a7c807f44ac008f4d3fba"},{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191021"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191020"},{"name":"skipInactive","type":"boolean","enumValues":"","default":"false","desc":"Boolean to prevent payout requests to inactive recipients. Defaults to false if not provided - you will invite and create requests for all the provided email addresses unless specified to true.","required":false,"in":"body","ref":"","_id":"654be801f8eb01006b9d24b2"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Create a Payout","icon":"","type":"endpoint","slug":"create-a-payout","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-a-bill","parentDoc":"63716adb1ae0f70033007743","createdAt":"2022-11-20T19:09:24.065Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]},{"_id":"637a7cac5340170031fee61f","api":{"method":"post","url":"/payouts/group","auth":"never","results":{"codes":[{"name":"","code":"{\n \"data\": {\n \"completed\": [\n {\n \"id\": \"JMwv8wQCXANoU2ZZQ9a9GH\",\n \"recipientId\": \"LDxRZCGq174SF8AnQpdBPB\",\n \"accountId\": \"SJcWZCFq344DL8QnXpdBNM\",\n \"shopperId\": \"7qohDf2zZnQK5Qanj8oyC2\",\n \"amount\": 10,\n \"currency\": \"USD\",\n \"ledgerCurrency\": \"GBP\",\n \"email\": \"john@doe.com\",\n \"reference\": \"payout_20210527\",\n \"label\": \"John Doe\",\n \"notificationURL\": \"https://yournotiticationURL.com/wed3sa0wx1rz5bg0bv97851eqx\",\n \"notificationEmail\": \"merchant@email.com\",\n \"effectiveDate\": \"2021-05-27T09:00:00.000Z\",\n \"requestDate\": \"2021-05-27T10:47:37.834Z\",\n \"status\": \"new\",\n \"groupId\": \"SxKRk4MdW8Ae3vsoR6UPQE\",\n \"transactions\": [],\n },\n {\n \"id\": \"JMwv8wQCXANoU2ZZQ9a9GH\",\n \"recipientId\": \"LDxRZCGq174SF8AnQpdBPB\",\n \"accountId\": \"2tRxwvX5JkVbhqBLGyanmF\",\n \"shopperId\": \"7qohDf2zZnQK5Qanj8oyC2\",\n \"amount\": 20,\n \"currency\": \"USD\",\n \"ledgerCurrency\": \"GBP\",\n \"email\": \"john@doe.com\",\n \"reference\": \"payout_20210527\",\n \"label\": \"John Doe 2\",\n \"notificationURL\": \"https://yournotiticationURL.com/wed3sa0wx1rz5bg0bv97851eqx\",\n \"notificationEmail\": \"merchant@email.com\",\n \"effectiveDate\": \"2021-05-27T09:00:00.000Z\",\n \"requestDate\": \"2021-05-27T10:47:37.834Z\",\n \"status\": \"new\",\n \"groupId\": \"SxKRk4MdW8Ae3vsoR6UPQE\",\n \"transactions\": []\n }\n ],\n \"failed\": [\n {\n \"errMessage\": \"Ledger currency is required\",\n \"payee\": \"john@doe.com\"\n }\n ]\n },\n}","language":"json","status":200}]},"params":[{"name":"instructions","type":"array_object","enumValues":"","default":"","desc":"Array of JSON objects made of the following parameters. Merchants can create several payouts in one group through a single call.","required":true,"in":"body","ref":"payoutInstructions","_id":"637a7d1038448408013135ee"},{"name":"token","type":"string","enumValues":"","default":"","desc":"Approved payout facade token.","required":true,"in":"body","ref":"","_id":"637a7c807f44ac008f4d3fba"},{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191021"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191020"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Create Payout Group","icon":"","type":"endpoint","slug":"create-payout-group","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716adb1ae0f70033007743","createdAt":"2022-11-20T19:14:52.726Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]},{"_id":"637a7e31b2e5890075d53803","api":{"method":"get","url":"/payouts/{payoutId}","auth":"required","results":{"codes":[{"name":"","code":"{\n \"facade\": \"payout/payout\",\n \"data\": {\n \"id\": \"JMwv8wQCXANoU2ZZQ9a9GH\",\n \"recipientId\": \"LDxRZCGq174SF8AnQpdBPB\",\n \"accountId\": \"SJcWZCFq344DL8QnXpdBNM\",\n \"shopperId\": \"7qohDf2zZnQK5Qanj8oyC2\",\n \"amount\": 10,\n \"currency\": \"USD\",\n \"ledgerCurrency\": \"GBP\",\n \"exchangeRates\": {\n \"BTC\": {\n \"USD\": 39390.47,\n \"GBP\": 27883.962246420004\n }\n },\n \"email\": \"john@doe.com\",\n \"reference\": \"payout_20210527\",\n \"label\": \"John Doe\",\n \"notificationURL\": \"https://yournotiticationURL.com/wed3sa0wx1rz5bg0bv97851eqx\",\n \"notificationEmail\": \"merchant@email.com\",\n \"effectiveDate\": \"2021-05-27T09:00:00.000Z\",\n \"requestDate\": \"2021-05-27T10:47:37.834Z\",\n \"dateExecuted\": \"2021-05-27T09:00:00.000Z\",\n \"status\": \"complete\",\n \"transactions\": [\n {\n \"txid\": \"db53d7e2bf3385a31257ce09396202d9c2823370a5ca186db315c45e24594057\",\n \"amount\": 0.000254,\n \"date\": \"2021-05-27T11:04:23.155Z\"\n }\n ],\n \"token\": \"6RZSTPtnzEaroAe2X4YijenRiqteRDNvzbT8NjtcHjUVd9FUFwa7dsX8RFgRDDC5SL\"\n },\n \"status\": \"success\",\n \"message\": null\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374167755cb9c00294ec5f0"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374164ec038610040ebede4"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"6374168a18b64e007e759b80"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"637416dbf2ff62001097f3b1"},{"name":"token","type":"string","enumValues":"","default":"","desc":"Approved payout facade token.","required":true,"in":"query","ref":"","_id":"63742d630b130c000fe8596b"},{"name":"payoutId","type":"string","enumValues":"","default":"","desc":"The id of the payout you want to retrieve.","required":false,"in":"path","ref":"","_id":"6379602f0c72e5000f81ebdb"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Retrieve a Payout","icon":"","type":"endpoint","slug":"retrieve-a-payout","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716adb1ae0f70033007743","createdAt":"2022-11-20T19:21:21.091Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]},{"_id":"637a7e6fa58c68008718966a","api":{"method":"get","url":"/payouts","auth":"required","results":{"codes":[{"name":"","code":"{\n \"facade\": \"payout/payout\",\n \"data\": [\n {\n \"id\": \"JMwv8wQCXANoU2ZZQ9a9GH\",\n \"recipientId\": \"LDxRZCGq174SF8AnQpdBPB\",\n \"shopperId\": \"7qohDf2zZnQK5Qanj8oyC2\",\n \"amount\": 10,\n \"currency\": \"USD\",\n \"ledgerCurrency\": \"GBP\",\n \"exchangeRates\": {\n \"BTC\": {\n \"USD\": 39390.47,\n \"GBP\": 27883.962246420004\n }\n },\n \"email\": \"john@doe.com\",\n \"reference\": \"payout_20210527\",\n \"label\": \"John Doe\",\n \"notificationURL\": \"https://yournotiticationURL.com/wed3sa0wx1rz5bg0bv97851eqx\",\n \"notificationEmail\": \"merchant@email.com\",\n \"effectiveDate\": \"2021-05-27T09:00:00.000Z\",\n \"requestDate\": \"2021-05-27T10:47:37.834Z\",\n \"status\": \"complete\",\n \"transactions\": [\n {\n \"txid\": \"db53d7e2bf3385a31257ce09396202d9c2823370a5ca186db315c45e24594057\",\n \"amount\": 0.000254,\n \"date\": \"2021-05-27T11:04:23.155Z\"\n }\n ],\n \"token\": \"9pVLfvdjt59q1JiY2JEsf2uzeeEpSqDwwfRAzuFr9CcrxZX25rTnP6HdRhsMBGLArz\"\n },\n {\n \"id\": \"KMXZeQigXG6T5abzCJmTcH\",\n \"recipientId\": \"LDxRZCGq174SF8AnQpdBPB\",\n \"shopperId\": \"7qohDf2zZnQK5Qanj8oyC2\",\n \"amount\": 10,\n \"currency\": \"USD\",\n \"ledgerCurrency\": \"GBP\",\n \"email\": \"jane@doe.com\",\n \"reference\": \"payout_20210528\",\n \"label\": \"Jane Doe\",\n \"notificationURL\": \"https://yournotiticationURL.com/wed3sa0wx1rz5bg0bv97851eqx\",\n \"notificationEmail\": \"merchant@email.com\",\n \"effectiveDate\": \"2021-05-28T09:00:00.000Z\",\n \"requestDate\": \"2021-05-28T10:23:43.765Z\",\n \"status\": \"cancelled\",\n \"transactions\": [],\n \"token\": \"9pVLfvdjt59q1JiY2JEsf2hr5FsjimfY4qRLFi85tMiXSCkJ9mQ2oSQqYKVangKaro\"\n }\n ],\n \"status\": \"success\",\n \"message\": null\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374167755cb9c00294ec5f0"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374164ec038610040ebede4"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"6374168a18b64e007e759b80"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"637416dbf2ff62001097f3b1"},{"name":"token","type":"string","enumValues":"","default":"","desc":"Approved payout facade token.","required":true,"in":"query","ref":"","_id":"63742d630b130c000fe8596b"},{"name":"startDate","type":"string","enumValues":"","default":"","desc":"The start of the date window to query for payouts by `effectiveDate`. Format `YYYY-MM-DD`. If no date is provided it will default to 90 days ago.","required":false,"in":"query","ref":"","_id":"637a7e98c5a6f3001e442982"},{"name":"endDate","type":"string","enumValues":"","default":"","desc":"The end of the date window to query for payouts by `effectiveDate`. Format `YYYY-MM-DD`. If no date is provided it will default to the date and time of the request.","required":false,"in":"query","ref":"","_id":"637a7e98c5a6f3001e442981"},{"name":"status","type":"string","enumValues":"","default":"","desc":"The payout status you want to query on.","required":false,"in":"query","ref":"","_id":"637a7ed8edd5f1001086f4ee"},{"name":"reference","type":"string","enumValues":"","default":"","desc":"The optional `reference` specified at payout creation.","required":false,"in":"query","ref":"","_id":"637a7ed8edd5f1001086f4ed"},{"name":"groupId","type":"string","enumValues":"","default":"","desc":"The `groupId` added to each payout that was created at the same time through the Create Payout Group request.","required":false,"in":"query","ref":"","_id":"637a7ed8edd5f1001086f4ec"},{"name":"limit","type":"int","enumValues":"","default":"","desc":"Maximum results that the query will return (useful for paging results).","required":false,"in":"query","ref":"","_id":"637a7ed8edd5f1001086f4eb"},{"name":"offset","type":"int","enumValues":"","default":"","desc":"Number of results to offset (ex. skip 10 will give you results starting with the 11th result).","required":false,"in":"query","ref":"","_id":"637a7ed8edd5f1001086f4ea"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Retrieve Payouts Filtered by Query","icon":"","type":"endpoint","slug":"retrieve-payouts-filtered-by-query","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716adb1ae0f70033007743","createdAt":"2022-11-20T19:22:23.411Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]},{"_id":"637a7f0336974800168ca557","api":{"method":"delete","url":"/payouts/{payoutId}","auth":"required","results":{"codes":[{"name":"","code":"{\n \"status\": \"success\",\n \"data\": {},\n \"message\": null\n}","language":"json","status":200}]},"params":[{"name":"payoutId","type":"string","enumValues":"","default":"","desc":"The specific payout id you want to cancel.","required":false,"in":"path","ref":"","_id":"6379602f0c72e5000f81ebdb"},{"name":"token","type":"string","enumValues":"","default":"","desc":"Approved payout facade token.","required":true,"in":"query","ref":"","_id":"63742d630b130c000fe8596b"},{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374167755cb9c00294ec5f0"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374164ec038610040ebede4"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"6374168a18b64e007e759b80"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"637416dbf2ff62001097f3b1"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Cancel a Payout","icon":"","type":"endpoint","slug":"cancel-a-payout","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716adb1ae0f70033007743","createdAt":"2022-11-20T19:24:51.529Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":false,"children":[]},{"_id":"637a7f4fa706710081029c89","api":{"method":"delete","url":"/payouts/group/{groupId}","auth":"required","results":{"codes":[{"name":"","code":"{\n \"data\": {\n \"cancelled\": [\n {\n \"id\": \"JMwv8wQCXANoU2ZZQ9a9GH\",\n \"recipientId\": \"LDxRZCGq174SF8AnQpdBPB\",\n \"accountId\": \"2tRxwvX5JkVbhqBLGyanmF\",\n \"shopperId\": \"7qohDf2zZnQK5Qanj8oyC2\",\n \"amount\": 10,\n \"currency\": \"USD\",\n \"ledgerCurrency\": \"GBP\",\n \"email\": \"john@doe.com\",\n \"reference\": \"payout_20210527\",\n \"label\": \"John Doe\",\n \"notificationURL\": \"https://yournotiticationURL.com/wed3sa0wx1rz5bg0bv97851eqx\",\n \"notificationEmail\": \"merchant@email.com\",\n \"effectiveDate\": \"2021-05-27T09:00:00.000Z\",\n \"requestDate\": \"2021-05-27T10:47:37.834Z\",\n \"status\": \"cancelled\",\n \"transactions\": [],\n },\n {\n \"id\": \"JMwv8wQCXANoU2ZZQ9a9GH\",\n \"recipientId\": \"LDxRZCGq174SF8AnQpdBPB\",\n \"accountId\": \"2tRxwvX5JkVbhqBLGyanmF\",\n \"shopperId\": \"7qohDf2zZnQK5Qanj8oyC2\",\n \"amount\": 20,\n \"currency\": \"USD\",\n \"ledgerCurrency\": \"GBP\",\n \"email\": \"john@doe.com\",\n \"reference\": \"payout_20210527\",\n \"label\": \"John Doe 2\",\n \"notificationURL\": \"https://yournotiticationURL.com/wed3sa0wx1rz5bg0bv97851eqx\",\n \"notificationEmail\": \"merchant@email.com\",\n \"effectiveDate\": \"2021-05-27T09:00:00.000Z\",\n \"requestDate\": \"2021-05-27T10:47:37.834Z\",\n \"status\": \"cancelled\",\n \"transactions\": [],\n }\n ],\n \"failed\": [\n {\n \"errMessage\": \"PayoutId is missing or invalid\",\n \"payoutId\": \"D8tgWzn1psUua4NYWW1vYo\"\n }\n ]\n },\n}","language":"json","status":200}]},"params":[{"name":"groupId","type":"string","enumValues":"","default":"","desc":"The the groupId of the collection of payouts you want to cancel.","required":false,"in":"path","ref":"","_id":"6379602f0c72e5000f81ebdb"},{"name":"token","type":"string","enumValues":"","default":"","desc":"Approved payout facade token.","required":true,"in":"query","ref":"","_id":"63742d630b130c000fe8596b"},{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374167755cb9c00294ec5f0"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374164ec038610040ebede4"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"6374168a18b64e007e759b80"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"637416dbf2ff62001097f3b1"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Cancel a Payout Group","icon":"","type":"endpoint","slug":"cancel-a-payout-group","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716adb1ae0f70033007743","createdAt":"2022-11-20T19:26:07.599Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":false,"children":[]},{"_id":"637a7f87f4e93d009f984514","api":{"method":"post","url":"/payouts/{payoutId}/notifications","auth":"never","results":{"codes":[{"name":"","code":"{\n \"status\": \"success\",\n \"data\": {},\n \"message\": null\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191021"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191020"},{"name":"payoutId","type":"string","enumValues":"","default":"","desc":"The id of the payout for which you want the last webhook to be resent.","required":false,"in":"path","ref":"","_id":"63757a865d284900961fddd9"},{"name":"token","type":"string","enumValues":"","default":"","desc":"Approved payout facade token.","required":true,"in":"body","ref":"","_id":"63757c590c80ef0072fb33a4"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Request a Payout Webhook to be Resent","icon":"","type":"endpoint","slug":"request-a-payout-webhook-to-be-resent","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716adb1ae0f70033007743","createdAt":"2022-11-20T19:27:03.579Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":false,"children":[]}]},{"_id":"63716ae2ff500f007c523bf9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Bills","icon":"","type":"basic","slug":"bills","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-13T22:08:34.956Z","category":"636c2e44f41a34006b3b0db2","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"637a802db950d10024e4d4d4","api":{"method":"post","url":"/bills","auth":"never","results":{"codes":[{"name":"pos facade","code":"{\n \"facade\": \"pos/bill\",\n \"data\": {\n \"status\": \"draft\",\n \"url\": \"https://bitpay.com/bill?id=X6KJbe9RxAGWNReCwd1xRw&resource=bills\",\n \"number\": \"bill1234-ABCD\",\n \"createdDate\": \"2021-05-21T09:48:02.373Z\",\n \"dueDate\": \"2021-05-31T00:00:00.000Z\",\n \"currency\": \"USD\",\n \"email\": \"john@doe.com\",\n \"cc\": [\n \"jane@doe.com\"\n ],\n \"passProcessingFee\": true,\n \"id\": \"X6KJbe9RxAGWNReCwd1xRw\",\n \"items\": [\n {\n \"id\": \"EL4vx41Nxc5RYhbqDthjE\",\n \"description\": \"Test Item 1\",\n \"price\": 6,\n \"quantity\": 1\n },\n {\n \"id\": \"6spPADZ2h6MfADvnhfsuBt\",\n \"description\": \"Test Item 2\",\n \"price\": 4,\n \"quantity\": 1\n }\n ],\n \"token\": \"qVVgRARN6fKtNZ7Tcq6qpoPBBE3NxdrmdMD883RyMK4Pf8EHENKVxCXhRwyynWveo\"\n }\n}","language":"json","status":200},{"code":"{\n \"facade\": \"merchant/bill\",\n \"data\": {\n \"status\": \"draft\",\n \"url\": \"https://bitpay.com/bill?id=3Zpmji8bRKxWJo2NJbWX5H&resource=bills\",\n \"number\": \"bill1234-EFGH\",\n \"createdDate\": \"2021-05-21T09:51:04.126Z\",\n \"dueDate\": \"2021-05-31T00:00:00.000Z\",\n \"currency\": \"USD\",\n \"name\": \"John Doe\",\n \"address1\": \"2630 Hegal Place\",\n \"address2\": \"Apt 42\",\n \"city\": \"Alexandria\",\n \"state\": \"VA\",\n \"zip\": \"23242\",\n \"country\": \"US\",\n \"email\": \"john@doe.com\",\n \"cc\": [\n \"jane@doe.com\"\n ],\n \"phone\": \"555-123-456\",\n \"passProcessingFee\": true,\n \"emailBill\": true,\n \"id\": \"3Zpmji8bRKxWJo2NJbWX5H\",\n \"merchant\": \"7HyKWn3d4xdhAMQYAEVxVq\",\n \"items\": [\n {\n \"id\": \"NV35GRWtrdB2cmGEjY4LKY\",\n \"description\": \"Test Item 1\",\n \"price\": 6,\n \"quantity\": 1\n },\n {\n \"id\": \"Apy3i2TpzHRYP8tJCkrZMT\",\n \"description\": \"Test Item 2\",\n \"price\": 4,\n \"quantity\": 1\n }\n ],\n \"token\": \"6EBQR37MgDJPfEiLY3jtRq7eTP2aodR5V5wmXyyZhru5FM5yF4RCGKYQtnT7nhwHjA\"\n }\n}","language":"json","status":200,"name":"merchant facade"}]},"params":[{"name":"number","type":"string","enumValues":"","default":"","desc":"Bill identifier, specified by merchant","required":false,"in":"body","ref":"","_id":"637a8177a8d90d000fa739b0"},{"name":"currency","type":"string","enumValues":"","default":"","desc":"ISO 4217 3-character currency code. This is the currency associated with the price field","required":true,"in":"body","ref":"","_id":"637a8177a8d90d000fa739af"},{"name":"name","type":"string","enumValues":"","default":"","desc":"Bill recipient's name","required":false,"in":"body","ref":"","_id":"637a8177a8d90d000fa739ae"},{"name":"address1","type":"string","enumValues":"","default":"","desc":"Bill recipient's address","required":false,"in":"body","ref":"","_id":"637a8177a8d90d000fa739ad"},{"name":"address2","type":"string","enumValues":"","default":"","desc":"Bill recipient's address","required":false,"in":"body","ref":"","_id":"637a8177a8d90d000fa739ac"},{"name":"city","type":"string","enumValues":"","default":"","desc":"Bill recipient's city","required":false,"in":"body","ref":"","_id":"637a8177a8d90d000fa739ab"},{"name":"state","type":"string","enumValues":"","default":"","desc":"Bill recipient's state or province","required":false,"in":"body","ref":"","_id":"637a8177a8d90d000fa739aa"},{"name":"zip","type":"string","enumValues":"","default":"","desc":"Bill recipient's ZIP code","required":false,"in":"body","ref":"","_id":"637a8177a8d90d000fa739a9"},{"name":"country","type":"string","enumValues":"","default":"","desc":"Bill recipient's country","required":false,"in":"body","ref":"","_id":"637a8177a8d90d000fa739a8"},{"name":"email","type":"string","enumValues":"","default":"","desc":"Bill recipient's email address","required":false,"in":"body","ref":"","_id":"637a8177a8d90d000fa739a7"},{"name":"cc","type":"array_string","enumValues":"","default":"","desc":"Email addresses to which a copy of the bill must be sent","required":false,"in":"body","ref":"","_id":"637a8177a8d90d000fa739a6"},{"name":"phone","type":"string","enumValues":"","default":"","desc":"Bill recipient's phone number","required":false,"in":"body","ref":"","_id":"637a8177a8d90d000fa739a5"},{"name":"dueDate","type":"string","enumValues":"","default":"","desc":"Date and time at which a bill is due, ISO-8601 format yyyy-mm-ddThh:mm:ssZ. (UTC)","required":false,"in":"body","ref":"","_id":"637a8177a8d90d000fa739a4"},{"name":"passProcessingFee","type":"boolean","enumValues":"","default":"","desc":"If set to `true`, BitPay's processing fee will be included in the amount charged on the invoice","required":false,"in":"body","ref":"","_id":"637a8177a8d90d000fa739a3"},{"name":"items","type":"array_object","enumValues":"","default":"","desc":"List of line items","required":true,"in":"body","ref":"lineItem","_id":"637a8177a8d90d000fa739a2"},{"name":"token","type":"string","enumValues":"","default":"","desc":"The API token can be retrieved from the dashboard (limited to `pos` facade) or using the Tokens resource to get access to the `merchant` facade. This is described in the section Request an API token).","required":true,"in":"body","ref":"","_id":"637a7c807f44ac008f4d3fba"},{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":false,"in":"header","ref":"","_id":"636c50f41dfbc5045d191021"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":false,"in":"header","ref":"","_id":"636c50f41dfbc5045d191020"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Create a Bill","icon":"","type":"endpoint","slug":"create-a-bill","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716ae2ff500f007c523bf9","createdAt":"2022-11-20T19:29:49.316Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]},{"_id":"637a822ae3599e004f7f4bb8","api":{"method":"get","url":"/bills/{billId}","auth":"required","results":{"codes":[{"name":"pos facade","code":"{\n \"facade\": \"pos/bill\",\n \"data\": {\n \"status\": \"draft\",\n \"url\": \"https://bitpay.com/bill?id=X6KJbe9RxAGWNReCwd1xRw&resource=bills\",\n \"number\": \"bill1234-ABCD\",\n \"createdDate\": \"2021-05-21T09:48:02.373Z\",\n \"dueDate\": \"2021-05-31T00:00:00.000Z\",\n \"currency\": \"USD\",\n \"email\": \"john@doe.com\",\n \"cc\": [\n \"jane@doe.com\"\n ],\n \"passProcessingFee\": true,\n \"id\": \"X6KJbe9RxAGWNReCwd1xRw\",\n \"items\": [\n {\n \"id\": \"EL4vx41Nxc5RYhbqDthjE\",\n \"description\": \"Test Item 1\",\n \"price\": 6,\n \"quantity\": 1\n },\n {\n \"id\": \"6spPADZ2h6MfADvnhfsuBt\",\n \"description\": \"Test Item 2\",\n \"price\": 4,\n \"quantity\": 1\n }\n ],\n \"token\": \"qVVgRARN6fKtNZ7Tcq6qpoPBBE3NxdrmdMD883RyMK4Pf8EHENKVxCXhRwyynWveo\"\n }\n}","language":"json","status":200},{"code":"{\n \"facade\": \"merchant/bill\",\n \"data\": {\n \"status\": \"draft\",\n \"url\": \"https://bitpay.com/bill?id=3Zpmji8bRKxWJo2NJbWX5H&resource=bills\",\n \"number\": \"bill1234-EFGH\",\n \"createdDate\": \"2021-05-21T09:51:04.126Z\",\n \"dueDate\": \"2021-05-31T00:00:00.000Z\",\n \"currency\": \"USD\",\n \"name\": \"John Doe\",\n \"address1\": \"2630 Hegal Place\",\n \"address2\": \"Apt 42\",\n \"city\": \"Alexandria\",\n \"state\": \"VA\",\n \"zip\": \"23242\",\n \"country\": \"US\",\n \"email\": \"john@doe.com\",\n \"cc\": [\n \"jane@doe.com\"\n ],\n \"phone\": \"555-123-456\",\n \"passProcessingFee\": true,\n \"emailBill\": true,\n \"id\": \"3Zpmji8bRKxWJo2NJbWX5H\",\n \"merchant\": \"7HyKWn3d4xdhAMQYAEVxVq\",\n \"items\": [\n {\n \"id\": \"NV35GRWtrdB2cmGEjY4LKY\",\n \"description\": \"Test Item 1\",\n \"price\": 6,\n \"quantity\": 1\n },\n {\n \"id\": \"Apy3i2TpzHRYP8tJCkrZMT\",\n \"description\": \"Test Item 2\",\n \"price\": 4,\n \"quantity\": 1\n }\n ],\n \"token\": \"6EBQR37MgDJPfEiLY3jtRq7eTP2aodR5V5wmXyyZhru5FM5yF4RCGKYQtnT7nhwHjA\"\n }\n}","language":"json","status":200,"name":"merchant facade"}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374167755cb9c00294ec5f0"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374164ec038610040ebede4"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"6374168a18b64e007e759b80"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"637416dbf2ff62001097f3b1"},{"name":"token","type":"string","enumValues":"","default":"","desc":"When fetching bills, pass a merchant facade token as a URL parameter.","required":true,"in":"query","ref":"","_id":"63742d630b130c000fe8596b"},{"name":"billId","type":"string","enumValues":"","default":"","desc":"The ID of the bill you want to retrieve.","required":false,"in":"path","ref":"","_id":"6379602f0c72e5000f81ebdb"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Retrieve a Bill","icon":"","type":"endpoint","slug":"retrieve-a-bill","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716ae2ff500f007c523bf9","createdAt":"2022-11-20T19:38:18.964Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]},{"_id":"637a894530966a0919c3b535","api":{"method":"put","url":"/bills/{billId}","auth":"required","results":{"codes":[{"name":"","code":"{\n \"facade\": \"merchant/bill\",\n \"data\": {\n \"url\": \"https://bitpay.com/bill?id=3Zpmji8bRKxWJo2NJbWX5H&resource=bills\",\n \"number\": \"bill1234-EFGH\",\n \"createdDate\": \"2021-05-21T09:51:04.126Z\",\n \"dueDate\": \"2021-05-31T00:00:00.000Z\",\n \"currency\": \"USD\",\n \"name\": \"John Doe\",\n \"address1\": \"2630 Hegal Place\",\n \"address2\": \"Apt 42\",\n \"city\": \"Alexandria\",\n \"state\": \"VA\",\n \"zip\": \"23242\",\n \"country\": \"US\",\n \"email\": \"john@doe.com\",\n \"cc\": [\n \"jane@doe.com\"\n ],\n \"phone\": \"555-123-456\",\n \"passProcessingFee\": true,\n \"emailBill\": true,\n \"id\": \"3Zpmji8bRKxWJo2NJbWX5H\",\n \"merchant\": \"7HyKWn3d4xdhAMQYAEVxVq\",\n \"items\": [\n {\n \"id\": \"8vXbhqWDL1A9F66ZwJAiyJ\",\n \"description\": \"Test Item 1\",\n \"price\": 6,\n \"quantity\": 1\n },\n {\n \"id\": \"WmgAaPiyuY9L6vBX7KvF2R\",\n \"description\": \"Test Item 2\",\n \"price\": 4,\n \"quantity\": 1\n },\n {\n \"id\": \"89xhSLYPnLDBczsQHCvJ2D\",\n \"description\": \"Test Item 3\",\n \"price\": 5,\n \"quantity\": 1\n }\n ],\n \"token\": \"7dnoyMe27VDKY1WNrCTqgK5RWbEi4XkvBSUTTwET6XnNYfWKYdrnSyg7myn7oc3vms\"\n }\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374167755cb9c00294ec5f0"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374164ec038610040ebede4"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"6374168a18b64e007e759b80"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"637416dbf2ff62001097f3b1"},{"name":"billId","type":"string","enumValues":"","default":"","desc":"The ID of the bill you want to update.","required":false,"in":"path","ref":"","_id":"6379602f0c72e5000f81ebdb"},{"name":"items","type":"array_object","enumValues":"","default":"","desc":"List of line items","required":false,"in":"body","ref":"lineItem","_id":"637a8a9bc8231b05babf690a"},{"name":"email","type":"string","enumValues":"","default":"","desc":"Bill recipient's email address","required":false,"in":"body","ref":"","_id":"637a8aacd079e40078527edd"},{"name":"token","type":"string","enumValues":"","default":"","desc":"The resource token for the billId you want to update. You need to retrieve this token from the bill object itself, using the merchant facade (see section Retrieve a bill).","required":true,"in":"body","ref":"","_id":"637a8aacd079e40078527edc"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Update a Bill","icon":"","type":"endpoint","slug":"update-a-bill","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716ae2ff500f007c523bf9","createdAt":"2022-11-20T20:08:37.917Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]},{"_id":"637a8ac62ec45e0384991738","api":{"method":"get","url":"/bills","auth":"required","results":{"codes":[{"name":"pos facade","code":"{\n \"facade\": \"merchant/bill\",\n \"data\": [\n {\n \"status\": \"draft\",\n \"url\": \"https://bitpay.com/bill?id=X6KJbe9RxAGWNReCwd1xRw&resource=bills\",\n \"number\": \"bill1234-ABCD\",\n \"createdDate\": \"2021-05-21T09:48:02.373Z\",\n \"dueDate\": \"2021-05-31T00:00:00.000Z\",\n \"currency\": \"USD\",\n \"name\": \"John Doe\",\n \"address1\": \"2630 Hegal Place\",\n \"address2\": \"Apt 42\",\n \"city\": \"Alexandria\",\n \"state\": \"VA\",\n \"zip\": \"23242\",\n \"country\": \"US\",\n \"email\": \"john@doe.com\",\n \"cc\": [\n \"jane@doe.com\"\n ],\n \"phone\": \"555-123-456\",\n \"passProcessingFee\": true,\n \"emailBill\": true,\n \"id\": \"X6KJbe9RxAGWNReCwd1xRw\",\n \"merchant\": \"7HyKWn3d4xdhAMQYAEVxVq\",\n \"items\": [\n {\n \"id\": \"EL4vx41Nxc5RYhbqDthjE\",\n \"description\": \"Test Item 1\",\n \"price\": 6,\n \"quantity\": 1\n },\n {\n \"id\": \"6spPADZ2h6MfADvnhfsuBt\",\n \"description\": \"Test Item 2\",\n \"price\": 4,\n \"quantity\": 1\n }\n ],\n \"token\": \"6EBQR37MgDJPfEiLY3jtRqBMYLg8XSDqhp2kp7VSDqCMHGHnsw4bqnnwQmtehzCvSo\"\n },\n {\n \"status\": \"draft\",\n \"url\": \"https://bitpay.com/bill?id=3Zpmji8bRKxWJo2NJbWX5H&resource=bills\",\n \"number\": \"bill1234-EFGH\",\n \"createdDate\": \"2021-05-21T09:51:04.126Z\",\n \"dueDate\": \"2021-05-31T00:00:00.000Z\",\n \"currency\": \"USD\",\n \"name\": \"John Doe\",\n \"address1\": \"2630 Hegal Place\",\n \"address2\": \"Apt 42\",\n \"city\": \"Alexandria\",\n \"state\": \"VA\",\n \"zip\": \"23242\",\n \"country\": \"US\",\n \"email\": \"john@doe.com\",\n \"cc\": [\n \"jane@doe.com\"\n ],\n \"phone\": \"555-123-456\",\n \"passProcessingFee\": true,\n \"emailBill\": true,\n \"id\": \"3Zpmji8bRKxWJo2NJbWX5H\",\n \"merchant\": \"7HyKWn3d4xdhAMQYAEVxVq\",\n \"items\": [\n {\n \"id\": \"NV35GRWtrdB2cmGEjY4LKY\",\n \"description\": \"Test Item 1\",\n \"price\": 6,\n \"quantity\": 1\n },\n {\n \"id\": \"Apy3i2TpzHRYP8tJCkrZMT\",\n \"description\": \"Test Item 2\",\n \"price\": 4,\n \"quantity\": 1\n }\n ],\n \"token\": \"6EBQR37MgDJPfEiLY3jtRq7eTP2aodR5V5wmXyyZhru5FM5yF4RCGKYQtnT7nhwHjA\"\n }\n ]\n}","language":"json","status":200},{"code":"{\n \"facade\": \"merchant/bill\",\n \"data\": {\n \"status\": \"draft\",\n \"url\": \"https://bitpay.com/bill?id=3Zpmji8bRKxWJo2NJbWX5H&resource=bills\",\n \"number\": \"bill1234-EFGH\",\n \"createdDate\": \"2021-05-21T09:51:04.126Z\",\n \"dueDate\": \"2021-05-31T00:00:00.000Z\",\n \"currency\": \"USD\",\n \"name\": \"John Doe\",\n \"address1\": \"2630 Hegal Place\",\n \"address2\": \"Apt 42\",\n \"city\": \"Alexandria\",\n \"state\": \"VA\",\n \"zip\": \"23242\",\n \"country\": \"US\",\n \"email\": \"john@doe.com\",\n \"cc\": [\n \"jane@doe.com\"\n ],\n \"phone\": \"555-123-456\",\n \"passProcessingFee\": true,\n \"emailBill\": true,\n \"id\": \"3Zpmji8bRKxWJo2NJbWX5H\",\n \"merchant\": \"7HyKWn3d4xdhAMQYAEVxVq\",\n \"items\": [\n {\n \"id\": \"NV35GRWtrdB2cmGEjY4LKY\",\n \"description\": \"Test Item 1\",\n \"price\": 6,\n \"quantity\": 1\n },\n {\n \"id\": \"Apy3i2TpzHRYP8tJCkrZMT\",\n \"description\": \"Test Item 2\",\n \"price\": 4,\n \"quantity\": 1\n }\n ],\n \"token\": \"6EBQR37MgDJPfEiLY3jtRq7eTP2aodR5V5wmXyyZhru5FM5yF4RCGKYQtnT7nhwHjA\"\n }\n}","language":"json","status":200,"name":"merchant facade"}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374167755cb9c00294ec5f0"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374164ec038610040ebede4"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"6374168a18b64e007e759b80"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"637416dbf2ff62001097f3b1"},{"name":"token","type":"string","enumValues":"","default":"","desc":"When fetching bills, pass a merchant facade token as a URL parameter.","required":true,"in":"query","ref":"","_id":"63742d630b130c000fe8596b"},{"name":"status","type":"string","enumValues":"","default":"","desc":"The bill status you want to query on","required":false,"in":"query","ref":"","_id":"637a8afdbaf1f2002ba44b4e"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Retrieve Bills by Status","icon":"","type":"endpoint","slug":"retrieve-bills-by-status","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716ae2ff500f007c523bf9","createdAt":"2022-11-20T20:15:02.636Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]},{"_id":"637a8b5bfedc30009fe37252","api":{"method":"post","url":"/bills/{billId}/deliveries","auth":"required","results":{"codes":[{"name":"","code":"{\n \"data\": \"Success\"\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374167755cb9c00294ec5f0"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374164ec038610040ebede4"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":false,"in":"header","ref":"","_id":"6374168a18b64e007e759b80"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":false,"in":"header","ref":"","_id":"637416dbf2ff62001097f3b1"},{"name":"token","type":"string","enumValues":"","default":"","desc":"When fetching bills, pass a merchant facade token as a URL parameter.","required":false,"in":"query","ref":"","_id":"63742d630b130c000fe8596b"},{"name":"billId","type":"string","enumValues":"","default":"","desc":"The ID of the bill you want to deliver via email.","required":false,"in":"path","ref":"","_id":"637a8beecdaf60004583de92"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Deliver a Bill Via Email","icon":"","type":"endpoint","slug":"deliver-a-bill-via-email","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716ae2ff500f007c523bf9","createdAt":"2022-11-20T20:17:31.492Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":false,"children":[]}]},{"_id":"63716aeae0109900568c10c9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Subscriptions","icon":"","type":"basic","slug":"subscriptions","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-13T22:08:42.899Z","category":"636c2e44f41a34006b3b0db2","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"637a8c63ea41cd0016c2d5da","api":{"method":"post","url":"/subscriptions","auth":"never","results":{"codes":[{"name":"","code":"{\n \"facade\": \"merchant/subscription\",\n \"data\": {\n \"id\": \"SeL33Hjyr3VmFHA5Skc4zy\",\n \"status\": \"draft\",\n \"billData\": {\n \"emailBill\": true,\n \"cc\": [\n \"jane@doe.com\"\n ],\n \"number\": \"subscription1234-ABCD\",\n \"currency\": \"USD\",\n \"name\": \"John Doe\",\n \"address1\": \"2630 Hegal Place\",\n \"address2\": \"Apt 42\",\n \"city\": \"Alexandria\",\n \"state\": \"VA\",\n \"zip\": \"23242\",\n \"country\": \"US\",\n \"email\": \"john@doe.com\",\n \"phone\": \"555-123-456\",\n \"dueDate\": \"2021-05-31T00:00:00.000Z\",\n \"passProcessingFee\": true,\n \"items\": [\n {\n \"description\": \"Test Item 1\",\n \"price\": 6,\n \"quantity\": 1\n },\n {\n \"description\": \"Test Item 2\",\n \"price\": 4,\n \"quantity\": 1\n }\n ],\n \"merchant\": \"5461e13dfd8b0047590d644a\"\n },\n \"schedule\": \"0 0 0 * * 1\",\n \"nextDelivery\": \"2021-05-24T00:00:00.000Z\",\n \"createdDate\": \"2021-05-21T12:29:54.428Z\",\n \"token\": \"85yxWk7aEgPdJME6zTkXkAGA3K13MtXf3WHqvtBvyhw3ycfEebJ5WMBRZHXsssSBvn\"\n }\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191021"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"636c50f41dfbc5045d191020"},{"name":"billData","type":"object","enumValues":"","default":"","desc":"Object containing the recurring billing information","required":true,"in":"body","ref":"bill","_id":"637a8cbd418ec70080d26717"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Create a Subscription","icon":"","type":"endpoint","slug":"create-a-subscription","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716aeae0109900568c10c9","createdAt":"2022-11-20T20:21:55.174Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]},{"_id":"637a8e87e168c600748365fe","api":{"method":"get","url":"/subscriptions/{subscriptionId}","auth":"required","results":{"codes":[{"name":"","code":"200 \n\n{\n \"facade\": \"merchant/subscription\",\n \"data\": {\n \"id\": \"6gqe8y5mkc5Qx2a9zmspgx\",\n \"status\": \"draft\",\n \"billData\": {\n \"emailBill\": true,\n \"cc\": [\n \"jane@doe.com\"\n ],\n \"number\": \"subscription1234-ABCD\",\n \"currency\": \"USD\",\n \"name\": \"John Doe\",\n \"address1\": \"2630 Hegal Place\",\n \"address2\": \"Apt 42\",\n \"city\": \"Alexandria\",\n \"state\": \"VA\",\n \"zip\": \"23242\",\n \"country\": \"US\",\n \"email\": \"john@doe.com\",\n \"phone\": \"555-123-456\",\n \"dueDate\": \"2021-05-31T00:00:00.000Z\",\n \"passProcessingFee\": true,\n \"items\": [\n {\n \"description\": \"Test Item 1\",\n \"price\": 6,\n \"quantity\": 1\n },\n {\n \"description\": \"Test Item 2\",\n \"price\": 4,\n \"quantity\": 1\n }\n ],\n \"merchant\": \"5461e13dfd8b0047590d644a\"\n },\n \"schedule\": \"0 0 0 * * 1\",\n \"nextDelivery\": \"2021-05-24T00:00:00.000Z\",\n \"createdDate\": \"2021-05-21T12:41:51.841Z\",\n \"token\": \"85yxWk7aEgPdJME6zTkXkA9UAGL1BW3TnJ3oTFYSa936qGRT2xDy6t5m9CUDhTt8w6\"\n }\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374167755cb9c00294ec5f0"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374164ec038610040ebede4"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"6374168a18b64e007e759b80"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"637416dbf2ff62001097f3b1"},{"name":"token","type":"string","enumValues":"","default":"","desc":"When fetching subscriptions, pass a merchant facade token as a URL parameter.","required":true,"in":"query","ref":"","_id":"63742d630b130c000fe8596b"},{"name":"subscriptionId","type":"string","enumValues":"","default":"","desc":"The ID of the subscription you want to retrieve.","required":false,"in":"path","ref":"","_id":"6379602f0c72e5000f81ebdb"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Retrieve a Subscription","icon":"","type":"endpoint","slug":"retrieve-a-subscription","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716aeae0109900568c10c9","createdAt":"2022-11-20T20:31:03.424Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]},{"_id":"637a8f070754920986af489b","api":{"method":"put","url":"/subscriptions/{subscriptionId}","auth":"required","results":{"codes":[{"name":"","code":"{\n \"facade\": \"merchant/subscription\",\n \"data\": {\n \"id\": \"SeL33Hjyr3VmFHA5Skc4zy\",\n \"status\": \"active\",\n \"billData\": {\n \"emailBill\": true,\n \"cc\": [\n \"jane@doe.com\"\n ],\n \"number\": \"subscription1234-ABCD\",\n \"currency\": \"USD\",\n \"name\": \"John Doe\",\n \"address1\": \"2630 Hegal Place\",\n \"address2\": \"Apt 42\",\n \"city\": \"Alexandria\",\n \"state\": \"VA\",\n \"zip\": \"23242\",\n \"country\": \"US\",\n \"email\": \"john@doe.com\",\n \"phone\": \"555-123-456\",\n \"dueDate\": \"2021-05-31T00:00:00.000Z\",\n \"passProcessingFee\": true,\n \"items\": [\n {\n \"description\": \"Test Item 1\",\n \"price\": 6,\n \"quantity\": 1\n },\n {\n \"description\": \"Test Item 2\",\n \"price\": 4,\n \"quantity\": 1\n }\n ],\n \"merchant\": \"5461e13dfd8b0047590d644a\"\n },\n \"schedule\": \"0 0 0 * * 1\",\n \"nextDelivery\": \"2021-05-24T00:00:00.000Z\",\n \"createdDate\": \"2021-05-21T12:29:54.428Z\",\n \"token\": \"85yxWk7aEgPdJME6zTkXkAGA3K13MtXf3WHqvtBvyhw3ycfEebJ5WMBRZHXsssSBvn\"\n }\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374167755cb9c00294ec5f0"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374164ec038610040ebede4"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"6374168a18b64e007e759b80"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"637416dbf2ff62001097f3b1"},{"name":"subscription","type":"string","enumValues":"","default":"","desc":"The ID of the subscription you want to update.","required":false,"in":"path","ref":"","_id":"6379602f0c72e5000f81ebdb"},{"name":"status","type":"string","enumValues":"","default":"","desc":"Can be `draft` or `active` or `cancelled`. Subscriptions in active state will create new Bills on the nextDelivery date.","required":false,"in":"body","ref":"","_id":"637a8f5ed4c5f7004049594d"},{"name":"billData","type":"object","enumValues":"","default":"","desc":"Object containing the recurring billing information","required":false,"in":"body","ref":"bill","_id":"637a8f5ed4c5f7004049594c"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Update a Subscription","icon":"","type":"endpoint","slug":"update-a-subscription","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716aeae0109900568c10c9","createdAt":"2022-11-20T20:33:11.218Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]},{"_id":"637a8fc2ad480c007c69d826","api":{"method":"get","url":"/subscriptions","auth":"required","results":{"codes":[{"name":"","code":"{\n \"facade\": \"merchant/subscription\",\n \"data\": [\n {\n \"id\": \"6gqe8y5mkc5Qx2a9zmspgx\",\n \"status\": \"draft\",\n \"billData\": {\n \"emailBill\": true,\n \"cc\": [\n \"jane@doe.com\"\n ],\n \"number\": \"subscription1234-ABCD\",\n \"currency\": \"USD\",\n \"name\": \"John Doe\",\n \"address1\": \"2630 Hegal Place\",\n \"address2\": \"Apt 42\",\n \"city\": \"Alexandria\",\n \"state\": \"VA\",\n \"zip\": \"23242\",\n \"country\": \"US\",\n \"email\": \"john@doe.com\",\n \"phone\": \"555-123-456\",\n \"dueDate\": \"2021-05-31T00:00:00.000Z\",\n \"passProcessingFee\": true,\n \"items\": [\n {\n \"description\": \"Test Item 1\",\n \"price\": 6,\n \"quantity\": 1\n },\n {\n \"description\": \"Test Item 2\",\n \"price\": 4,\n \"quantity\": 1\n }\n ],\n \"merchant\": \"5461e13dfd8b0047590d644a\"\n },\n \"schedule\": \"0 0 0 * * 1\",\n \"nextDelivery\": \"2021-05-24T00:00:00.000Z\",\n \"createdDate\": \"2021-05-21T12:41:51.841Z\",\n \"token\": \"85yxWk7aEgPdJME6zTkXkA9UAGL1BW3TnJ3oTFYSa936qGRT2xDy6t5m9CUDhTt8w6\"\n },\n {\n \"id\": \"2WDabp4eXU2UMbPYKYoPwA\",\n \"status\": \"draft\",\n \"billData\": {\n \"emailBill\": true,\n \"cc\": [\n \"jane@doe.com\"\n ],\n \"number\": \"subscription1234-EFGH\",\n \"currency\": \"USD\",\n \"name\": \"John Doe\",\n \"address1\": \"2630 Hegal Place\",\n \"address2\": \"Apt 42\",\n \"city\": \"Alexandria\",\n \"state\": \"VA\",\n \"zip\": \"23242\",\n \"country\": \"US\",\n \"email\": \"john@doe.com\",\n \"phone\": \"555-123-456\",\n \"dueDate\": \"2021-05-31T00:00:00.000Z\",\n \"passProcessingFee\": true,\n \"items\": [\n {\n \"description\": \"Test Item 1\",\n \"price\": 6,\n \"quantity\": 1\n },\n {\n \"description\": \"Test Item 2\",\n \"price\": 4,\n \"quantity\": 1\n }\n ],\n \"merchant\": \"5461e13dfd8b0047590d644a\"\n },\n \"schedule\": \"0 0 0 * * 1\",\n \"nextDelivery\": \"2021-05-24T00:00:00.000Z\",\n \"createdDate\": \"2021-05-21T12:42:01.029Z\",\n \"token\": \"85yxWk7aEgPdJME6zTkXkACFxcVxzQuhyGuYv4ESYEgdkReFnqzN5WdACzSNGEBE99\"\n }\n ]\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374167755cb9c00294ec5f0"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"6374164ec038610040ebede4"},{"name":"X-Identity","type":"string","enumValues":"","default":"","desc":"The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"6374168a18b64e007e759b80"},{"name":"X-Signature","type":"string","enumValues":"","default":"","desc":"The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a `merchant` facade token.","required":true,"in":"header","ref":"","_id":"637416dbf2ff62001097f3b1"},{"name":"token","type":"string","enumValues":"","default":"","desc":"When fetching subscriptions, pass a merchant facade token as a URL parameter.","required":true,"in":"query","ref":"","_id":"63742d630b130c000fe8596b"},{"name":"status","type":"string","enumValues":"","default":"","desc":"The subscription status you want to query on","required":false,"in":"query","ref":"","_id":"637a8afdbaf1f2002ba44b4e"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Retrieve Subscriptions by Status","icon":"","type":"endpoint","slug":"retrieve-subscriptions-by-status","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716aeae0109900568c10c9","createdAt":"2022-11-20T20:36:18.590Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]}]},{"_id":"63716af07f08dc00830be9b4","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Rates","icon":"","type":"basic","slug":"rates","order":9,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-13T22:08:48.328Z","category":"636c2e44f41a34006b3b0db2","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"63757da0f46d6f005a4e8316","api":{"method":"get","url":"/rates/{basecurrency}","auth":"never","results":{"codes":[{"name":"","code":"{\n \"data\":[\n {\n \"code\":\"BTC\",\n \"name\":\"Bitcoin\",\n \"rate\":1\n },\n {\n \"code\":\"BCH\",\n \"name\":\"Bitcoin Cash\",\n \"rate\":50.77\n },\n {\n \"code\":\"USD\",\n \"name\":\"US Dollar\",\n \"rate\":41248.11\n },\n {\n \"code\":\"EUR\",\n \"name\":\"Eurozone Euro\",\n \"rate\":33823.04\n },\n {\n \"code\":\"GBP\",\n \"name\":\"Pound Sterling\",\n \"rate\":29011.49\n },\n {\n \"code\":\"JPY\",\n \"name\":\"Japanese Yen\",\n \"rate\":4482741\n },\n {\n \"code\":\"CAD\",\n \"name\":\"Canadian Dollar\",\n \"rate\":49670.85\n },\n {\n \"code\":\"AUD\",\n \"name\":\"Australian Dollar\",\n \"rate\":53031.99\n },\n {\n \"code\":\"CNY\",\n \"name\":\"Chinese Yuan\",\n \"rate\":265266.57\n },\n ...\n ]\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"},{"name":"baseCurrency","type":"string","enumValues":"","default":"","desc":"The cryptocurrency for which you want to fetch the rates. Current supported values are BTC and BCH","required":false,"in":"path","ref":"","_id":"63757a865d284900961fddd9"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Retrieve all the rates for a given cryptocurrency","icon":"","type":"endpoint","slug":"retrieve-all-the-rates-for-a-given-cryptocurrency","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716af07f08dc00830be9b4","createdAt":"2022-11-17T00:17:36.299Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]},{"_id":"63757ebf1b63b4002b0ea620","api":{"method":"get","url":"/rates/{basecurrency}/{currency}","auth":"never","results":{"codes":[{"name":"","code":"{\n \"data\":{\n \"code\":\"USD\",\n \"name\":\"US Dollar\",\n \"rate\":41154.05\n }\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"},{"name":"baseCurrency","type":"string","enumValues":"","default":"","desc":"The cryptocurrency for which you want to fetch the rates. Current supported values are BTC and BCH","required":false,"in":"path","ref":"","_id":"63757a865d284900961fddd9"},{"name":"currency","type":"string","enumValues":"","default":"","desc":"the fiat currency for which you want to fetch the `baseCurrency` rates","required":false,"in":"path","ref":"","_id":"63757f606416c1000f573d79"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Retrieve the rates for a cryptocurrency / fiat pair","icon":"","type":"endpoint","slug":"retrieve-the-rates-for-a-cryptocurrency-fiat-pair","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716af07f08dc00830be9b4","createdAt":"2022-11-17T00:22:23.273Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]}]},{"_id":"63716af5975454004c141505","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Sessions","icon":"","type":"basic","slug":"sessions","order":10,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-13T22:08:53.885Z","category":"636c2e44f41a34006b3b0db2","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"63757fade328770032936d31","api":{"method":"post","url":"/sessions","auth":"never","results":{"codes":[{"name":"","code":"{\n \"data\": \"9d3dc999f49eec7a96854a802f800efa0ba1e883f5a7d509a8d34ea0133bd7c8\"\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Create an API Session","icon":"","type":"endpoint","slug":"create-an-api-session","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716af5975454004c141505","createdAt":"2022-11-17T00:26:21.263Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]}]},{"_id":"63716afc10ce8900a84a404e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Currencies","icon":"","type":"basic","slug":"currencies","order":11,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-13T22:09:00.325Z","category":"636c2e44f41a34006b3b0db2","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"63757fdf0bae63009b1eef34","api":{"method":"get","url":"/currencies","auth":"never","results":{"codes":[{"name":"","code":"{\n \"data\": [\n {\n \"code\": \"BTC\",\n \"symbol\": \"฿\",\n \"precision\": 6,\n \"name\": \"Bitcoin\",\n \"plural\": \"Bitcoin\",\n \"alts\": \"btc\",\n \"minimum\": 0.000006,\n \"sanctioned\": false,\n \"decimals\": 8,\n \"chain\": \"BTC\"\n },\n ...\n ...\n {\n \"code\": \"XRP\",\n \"symbol\": \"Ʀ\",\n \"precision\": 6,\n \"name\": \"Ripple\",\n \"plural\": \"Ripple\",\n \"alts\": \"xrp\",\n \"minimum\": 0.000006,\n \"sanctioned\": false,\n \"decimals\": 6,\n \"chain\": \"XRP\"\n },\n ...\n ...\n {\n \"code\": \"EUR\",\n \"symbol\": \"€\",\n \"precision\": 2,\n \"name\": \"Eurozone Euro\",\n \"plural\": \"Eurozone Euros\",\n \"alts\": \"eur\",\n \"minimum\": 0.01,\n \"sanctioned\": false,\n \"decimals\": 2\n },\n ...\n ...\n {\n \"code\": \"USD\",\n \"symbol\": \"$\",\n \"precision\": 2,\n \"name\": \"US Dollar\",\n \"plural\": \"US Dollars\",\n \"alts\": \"usd bucks\",\n \"minimum\": 0.01,\n \"sanctioned\": false,\n \"decimals\": 2\n },\n {\n \"code\": \"USDC\",\n \"symbol\": \"$\",\n \"precision\": 2,\n \"name\": \"Circle USD Coin\",\n \"plural\": \"Circle USD Coin\",\n \"alts\": \"\",\n \"minimum\": 0.01,\n \"sanctioned\": false,\n \"decimals\": 6,\n \"chain\": \"ETH\"\n },\n ...\n ...\n ]\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Retrieve the Supported Currencies","icon":"","type":"endpoint","slug":"retrieve-the-supported-currencies","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"currencies-1","parentDoc":"63716afc10ce8900a84a404e","createdAt":"2022-11-17T00:27:11.662Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]}]},{"_id":"63716b05d7cb5f009de52e0e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Wallets","icon":"","type":"basic","slug":"wallets","order":12,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-13T22:09:09.506Z","category":"636c2e44f41a34006b3b0db2","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"63758075e328770032939392","api":{"method":"get","url":"/supportedwallets","auth":"never","results":{"codes":[{"name":"","code":"{\n \"data\": [\n {\n \"key\": \"bitpay\",\n \"displayName\": \"BitPay\",\n \"avatar\": \"bitpay-wallet.png\",\n \"payPro\": true,\n \"currencies\": [\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"BIP72b\"\n },\n \"code\": \"BTC\",\n \"image\": \"https://bitpay.com/img/icon/currencies/BTC.svg\"\n },\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"BIP72b\"\n },\n \"code\": \"BCH\",\n \"image\": \"https://bitpay.com/img/icon/currencies/BCH.svg\"\n },\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"BIP72b\"\n },\n \"code\": \"XRP\",\n \"image\": \"https://bitpay.com/img/icon/currencies/XRP.svg\"\n },\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"BIP72b\"\n },\n \"code\": \"DOGE\",\n \"image\": \"https://bitpay.com/img/icon/currencies/DOGE.svg\"\n },\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"EIP681\"\n },\n \"code\": \"ETH\",\n \"image\": \"https://bitpay.com/img/icon/currencies/ETH.svg\"\n },\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"EIP681b\"\n },\n \"code\": \"USDC\",\n \"image\": \"https://bitpay.com/img/icon/currencies/USDC.svg\"\n },\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"EIP681b\"\n },\n \"code\": \"PAX\",\n \"image\": \"https://bitpay.com/img/icon/currencies/PAX.svg\"\n },\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"EIP681b\"\n },\n \"code\": \"GUSD\",\n \"image\": \"https://bitpay.com/img/icon/currencies/GUSD.svg\"\n },\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"EIP681b\"\n },\n \"code\": \"BUSD\",\n \"image\": \"https://bitpay.com/img/icon/currencies/BUSD.svg\"\n },\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"EIP681b\"\n },\n \"code\": \"WBTC\",\n \"image\": \"https://bitpay.com/img/icon/currencies/WBTC.svg\"\n },\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"EIP681b\"\n },\n \"code\": \"SHIB\",\n \"image\": \"https://bitpay.com/img/icon/currencies/SHIB.svg\"\n },\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"EIP681b\"\n },\n \"code\": \"DAI\",\n \"image\": \"https://bitpay.com/img/icon/currencies/DAI.svg\"\n },\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"BIP72b\"\n },\n \"code\": \"LTC\",\n \"image\": \"https://bitpay.com/img/icon/currencies/LTC.svg\"\n },\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"EIP681b\"\n },\n \"code\": \"APE\",\n \"image\": \"https://bitpay.com/img/icon/currencies/APE.svg\"\n },\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"EIP681b\"\n },\n \"code\": \"EUROC\",\n \"image\": \"https://bitpay.com/img/icon/currencies/EUROC.svg\"\n }\n ],\n \"image\": \"https://bitpay.com/img/wallet-logos/bitpay-wallet.png\"\n },\n ...\n ...\n {\n \"key\": \"copay\",\n \"displayName\": \"Copay\",\n \"avatar\": \"copay-wallet.svg\",\n \"payPro\": true,\n \"currencies\": [\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"BIP72b\"\n },\n \"code\": \"BTC\",\n \"image\": \"https://bitpay.com/img/icon/currencies/BTC.svg\"\n },\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"BIP72b\"\n },\n \"code\": \"BCH\",\n \"image\": \"https://bitpay.com/img/icon/currencies/BCH.svg\"\n },\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"BIP72b\"\n },\n \"code\": \"XRP\",\n \"image\": \"https://bitpay.com/img/icon/currencies/XRP.svg\"\n },\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"BIP72b\"\n },\n \"code\": \"DOGE\",\n \"image\": \"https://bitpay.com/img/icon/currencies/DOGE.svg\"\n },\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"EIP681\"\n },\n \"code\": \"ETH\",\n \"image\": \"https://bitpay.com/img/icon/currencies/ETH.svg\"\n },\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"EIP681b\"\n },\n \"code\": \"USDC\",\n \"image\": \"https://bitpay.com/img/icon/currencies/USDC.svg\"\n },\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"EIP681b\"\n },\n \"code\": \"PAX\",\n \"image\": \"https://bitpay.com/img/icon/currencies/PAX.svg\"\n },\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"EIP681b\"\n },\n \"code\": \"GUSD\",\n \"image\": \"https://bitpay.com/img/icon/currencies/GUSD.svg\"\n },\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"EIP681b\"\n },\n \"code\": \"BUSD\",\n \"image\": \"https://bitpay.com/img/icon/currencies/BUSD.svg\"\n },\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"EIP681b\"\n },\n \"code\": \"WBTC\",\n \"image\": \"https://bitpay.com/img/icon/currencies/WBTC.svg\"\n },\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"EIP681b\"\n },\n \"code\": \"SHIB\",\n \"image\": \"https://bitpay.com/img/icon/currencies/SHIB.svg\"\n },\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"EIP681b\"\n },\n \"code\": \"DAI\",\n \"image\": \"https://bitpay.com/img/icon/currencies/DAI.svg\"\n },\n {\n \"payPro\": true,\n \"qr\": {\n \"type\": \"BIP72b\"\n },\n \"code\": \"LTC\",\n \"image\": \"https://bitpay.com/img/icon/currencies/LTC.svg\"\n }\n ],\n \"image\": \"https://bitpay.com/img/wallet-logos/copay-wallet.svg\"\n },\n ...\n ...\n {\n \"key\": \"blockchainWallet\",\n \"displayName\": \"Blockchain Wallet\",\n \"avatar\": \"blockchain-wallet.svg\",\n \"payPro\": true,\n \"invoiceDefault\": \"BTC\",\n \"uniCode\": \"bitcoin:?r=https://bitpay.com\",\n \"verificationLink\": \"https://bitpay.com/id/verify\",\n \"currencies\": [\n {\n \"payPro\": true,\n \"p2p\": true,\n \"qr\": {\n \"type\": \"BIP72b\"\n },\n \"code\": \"BTC\",\n \"image\": \"https://bitpay.com/img/icon/currencies/BTC.svg\"\n },\n {\n \"p2p\": true,\n \"payPro\": true,\n \"qr\": {\n \"type\": \"BIP72b\"\n },\n \"code\": \"BCH\",\n \"image\": \"https://bitpay.com/img/icon/currencies/BCH.svg\"\n }\n ],\n \"image\": \"https://bitpay.com/img/wallet-logos/blockchain-wallet.svg\"\n },\n ...\n ...\n {\n \"key\": \"squareCash\",\n \"displayName\": \"Cash App\",\n \"lightning\": true,\n \"avatar\": \"square-cash-app.svg\",\n \"payPro\": false,\n \"currencies\": [\n {\n \"p2p\": true,\n \"qr\": {\n \"type\": \"ADDRESS\"\n },\n \"code\": \"BTC\",\n \"image\": \"https://bitpay.com/img/icon/currencies/BTC.svg\"\n }\n ],\n \"image\": \"https://bitpay.com/img/wallet-logos/square-cash-app.svg\"\n },\n ...\n ...\n {\n \"key\": \"coinbase\",\n \"displayName\": \"Coinbase\",\n \"avatar\": \"coinbase.svg\",\n \"offChainMode\": true,\n \"payPro\": false,\n \"currencies\": [\n {\n \"p2p\": true,\n \"qr\": {\n \"collapsed\": true,\n \"type\": \"ADDRESS\"\n },\n \"code\": \"BTC\",\n \"image\": \"https://bitpay.com/img/icon/currencies/BTC.svg\"\n },\n {\n \"p2p\": true,\n \"qr\": {\n \"collapsed\": true,\n \"type\": \"ADDRESS\"\n },\n \"code\": \"BCH\",\n \"image\": \"https://bitpay.com/img/icon/currencies/BCH.svg\"\n },\n {\n \"p2p\": true,\n \"qr\": {\n \"collapsed\": true,\n \"type\": \"ADDRESS\"\n },\n \"code\": \"XRP\",\n \"image\": \"https://bitpay.com/img/icon/currencies/XRP.svg\"\n },\n {\n \"p2p\": true,\n \"qr\": {\n \"collapsed\": true,\n \"type\": \"ADDRESS\"\n },\n \"code\": \"DOGE\",\n \"image\": \"https://bitpay.com/img/icon/currencies/DOGE.svg\"\n }\n ],\n \"image\": \"https://bitpay.com/img/wallet-logos/coinbase.svg\"\n },\n ...\n ...\n {\n \"key\": \"gemini\",\n \"displayName\": \"Gemini\",\n \"avatar\": \"gemini.svg\",\n \"payPro\": false,\n \"currencies\": [\n {\n \"p2p\": true,\n \"qr\": {\n \"collapsed\": true,\n \"type\": \"ADDRESS\"\n },\n \"code\": \"BTC\",\n \"image\": \"https://bitpay.com/img/icon/currencies/BTC.svg\"\n },\n {\n \"p2p\": true,\n \"qr\": {\n \"collapsed\": true,\n \"type\": \"ADDRESS\"\n },\n \"code\": \"BCH\",\n \"image\": \"https://bitpay.com/img/icon/currencies/BCH.svg\"\n },\n {\n \"p2p\": true,\n \"qr\": {\n \"collapsed\": true,\n \"type\": \"ADDRESS\"\n },\n \"code\": \"LTC\",\n \"image\": \"https://bitpay.com/img/icon/currencies/LTC.svg\"\n }\n ],\n \"image\": \"https://bitpay.com/img/wallet-logos/gemini.svg\"\n },\n ...\n ...\n {\n \"key\": \"bakkt\",\n \"displayName\": \"Bakkt\",\n \"avatar\": \"bakkt.svg\",\n \"uniCode\": \"bakkt://bitpay\",\n \"offChainMode\": true,\n \"invoiceDefault\": \"USD\",\n \"payPro\": false,\n \"currencies\": [],\n \"image\": \"https://bitpay.com/img/wallet-logos/bakkt.svg\"\n }\n ]\n}","language":"json","status":200}]},"params":[{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"Must be set to `application/json` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cfe"},{"name":"X-Accept-Version","type":"string","enumValues":"","default":"2.0.0","desc":"Must be set to `2.0.0` for requests to the BitPay API","required":true,"in":"header","ref":"","_id":"636c506f1f64dd00166b2cff"}],"examples":{"codes":[]},"apiSetting":"63595c46f0170204f0097ec1"},"title":"Retrieve the Supported Wallets","icon":"","type":"endpoint","slug":"retrieve-the-supported-wallets","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63716b05d7cb5f009de52e0e","createdAt":"2022-11-17T00:29:41.111Z","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":true,"children":[]}]},{"_id":"637435e6366d41005182e96f","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Notifications (IPN)","icon":"","type":"basic","slug":"notifications","order":13,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-16T00:59:18.588Z","category":"636c2e44f41a34006b3b0db2","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"63743793260567004fa36dce","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Invoices","icon":"","type":"basic","slug":"notifications-invoices","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"invoices-1","createdAt":"2022-11-16T01:06:27.873Z","parentDoc":"637435e6366d41005182e96f","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":false,"children":[]},{"_id":"637a9098195ca60882f07f82","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Refunds","icon":"","type":"basic","slug":"notifications-refunds","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"refunds-1","createdAt":"2022-11-20T20:39:52.083Z","parentDoc":"637435e6366d41005182e96f","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":false,"children":[]},{"_id":"637a909d039d9a009a2ac12f","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Recipients","icon":"","type":"basic","slug":"notifications-recipients","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"recipients-1","createdAt":"2022-11-20T20:39:57.933Z","parentDoc":"637435e6366d41005182e96f","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":false,"children":[]},{"_id":"637a90a30490ac00929e9d91","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Payouts","icon":"","type":"basic","slug":"notifications-payouts","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"payouts-1","createdAt":"2022-11-20T20:40:03.114Z","parentDoc":"637435e6366d41005182e96f","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":false,"children":[]},{"_id":"6390b84ce6141a008abed582","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Notification Codes","icon":"","type":"basic","slug":"notification-codes","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-12-07T15:59:08.140Z","parentDoc":"637435e6366d41005182e96f","category":"636c2e44f41a34006b3b0db2","isBodyEmpty":false,"children":[]},{"_id":"667c8add7b32cd0071ff751a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"HMAC Verification","icon":"","type":"basic","slug":"hmac-verification","order":999,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"637435e6366d41005182e96f","category":"636c2e44f41a34006b3b0db2","createdAt":"2024-06-26T21:40:45.617Z","isBodyEmpty":false,"children":[]}]}]},{"_id":"63b72b6e460c60008573ad9a","title":"SDKs","slug":"sdks","order":4,"reference":true,"project":"6356ce887031fa001e26e989","version":"6356ce887031fa001e26e98e","createdAt":"2023-01-05T19:56:30.257Z","__v":0,"pages":[{"_id":"63c1b48e120e0c0738fab639","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"BitPay SDK Overview","icon":"","type":"basic","slug":"bitpay-sdk-overview","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"bitpay-concepts","category":"63b72b6e460c60008573ad9a","createdAt":"2023-01-13T19:44:14.134Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"63c1d3deac9390002c77a1a9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Lite vs. Full SDK","icon":"","type":"basic","slug":"lite-vs-full-sdk","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"63b72b6e460c60008573ad9a","createdAt":"2023-01-13T21:57:50.236Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"63723c063556b70bb4956356","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"C# SDK","icon":"","type":"basic","slug":"c-full-sdk-overview","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"overview-1","createdAt":"2022-11-14T13:00:54.166Z","category":"63b72b6e460c60008573ad9a","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"64f2194c7b5b39006fcf136c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"C# Full SDK (version < 5.0.0)","icon":"","type":"basic","slug":"c-full-sdk-version-500","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","createdAt":"2023-09-01T17:03:08.432Z","isBodyEmpty":false,"children":[]},{"_id":"63723ce2e7097109add479f7","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Create an Invoice","icon":"","type":"basic","slug":"c-full-sdk-create-an-invoice","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-an-invoice","createdAt":"2022-11-14T13:04:34.082Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63723df6964acd005312bb01","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Retrieve an Invoice","icon":"","type":"basic","slug":"c-full-sdk-retrieve-an-invoice","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-an-invoice","createdAt":"2022-11-14T13:09:10.888Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63723f25deaa9e05b36ad5d4","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Retrieve Invoice Filtered By Query","icon":"","type":"basic","slug":"c-full-sdk-retrieve-invoice-filtered-by-query","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-invoice-filtered-by-query","createdAt":"2022-11-14T13:14:13.093Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63723f580fb2060bcddccb3d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Update Invoice","icon":"","type":"basic","slug":"c-full-sdk-update-invoice","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"update-invoice","createdAt":"2022-11-14T13:15:04.582Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63723fd13beb65002b3ae56d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Delete an Invoice","icon":"","type":"basic","slug":"c-full-sdk-delete-an-invoice","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"delete-an-invoice","createdAt":"2022-11-14T13:17:05.664Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63724065592a14001e3d0820","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Create a Bill","icon":"","type":"basic","slug":"c-full-sdk-create-a-bill","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-a-bill","createdAt":"2022-11-14T13:19:33.007Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"6372408e53b7e500488a166a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Retrieve a Bill","icon":"","type":"basic","slug":"c-full-sdk-retrieve-a-bill","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-a-bill","createdAt":"2022-11-14T13:20:14.583Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"6372426a592a14001e3d2822","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Update a Bill","icon":"","type":"basic","slug":"c-full-sdk-update-a-bill","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"update-a-bill","createdAt":"2022-11-14T13:28:10.595Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"637242910823c80c0854ac6d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Deliver a Bill","icon":"","type":"basic","slug":"c-full-sdk-deliver-a-bill","order":9,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"deliver-a-bill","createdAt":"2022-11-14T13:28:49.445Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63724321531f710323956523","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get Ledgers","icon":"","type":"basic","slug":"c-full-sdk-get-ledgers","order":10,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-ledgers","createdAt":"2022-11-14T13:31:13.322Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"637247703beb65002b3b7ee8","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Create Payout Recipients","icon":"","type":"basic","slug":"c-full-sdk-create-payout-recipients","order":11,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-payout-recipients","createdAt":"2022-11-14T13:49:36.384Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"6372482cd7cb5f009df1a6dc","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get Payout Recipient by ID","icon":"","type":"basic","slug":"c-full-sdk-get-payout-recipient-by-id","order":12,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-payout-recipient-by-id","createdAt":"2022-11-14T13:52:44.243Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"637248855d9b2c021434233e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get Payout Recipients","icon":"","type":"basic","slug":"c-full-sdk-get-payout-recipients","order":13,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-payout-recipients","createdAt":"2022-11-14T13:54:13.555Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"637249101ae0f700330d5786","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Update Payout Recipient","icon":"","type":"basic","slug":"c-full-sdk-update-payout-recipient","order":14,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"update-payout-recipient","createdAt":"2022-11-14T13:56:32.172Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63724943a3b9fb06e4214028","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Delete Payout Recipient","icon":"","type":"basic","slug":"c-full-sdk-delete-payout-recipient","order":15,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"delete-payout-recipient","createdAt":"2022-11-14T13:57:23.119Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63724985a262bf0934162480","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Request Payout Recipient Notification","icon":"","type":"basic","slug":"c-full-sdk-request-payout-recipient-notification","order":16,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"request-payout-recipient-notification","createdAt":"2022-11-14T13:58:29.394Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"637249a1d54bae0010e59c6d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Recipient Webhooks","icon":"","type":"basic","slug":"c-full-sdk-recipient-webhooks","order":17,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"recipient-webhooks","createdAt":"2022-11-14T13:58:57.615Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63724d80885c8a000f35e549","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Create Payout Request","icon":"","type":"basic","slug":"c-full-sdk-create-payout-request","order":18,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-payout-request","createdAt":"2022-11-14T14:15:28.023Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63724e04e49f2803ee0bdaf2","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get Payout Request by ID","icon":"","type":"basic","slug":"c-full-sdk-get-payout-request-by-id","order":19,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-payout-request-by-id","createdAt":"2022-11-14T14:17:40.098Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63724de609e3f00b7efe3b36","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get Payout Request","icon":"","type":"basic","slug":"c-full-sdk-get-payout-request","order":20,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-payout-request","createdAt":"2022-11-14T14:17:10.918Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63724e43d89d2d097687fbbc","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Cancel Payouts","icon":"","type":"basic","slug":"c-full-sdk-cancel-payouts","order":21,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"cancel-payouts","createdAt":"2022-11-14T14:18:43.730Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63724e76284da306012d34ea","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Request Payout Notification","icon":"","type":"basic","slug":"request-payout-notification-1","order":22,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-14T14:19:34.538Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63724e991d58db000f55d6db","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Payout Webhooks","icon":"","type":"basic","slug":"c-full-sdk-payout-webhooks","order":23,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"payout-webhooks","createdAt":"2022-11-14T14:20:09.630Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63724f28e2c5ab09f123316a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get Exchange Rates","icon":"","type":"basic","slug":"c-full-sdk-get-exchange-rates","order":24,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-exchange-rates","createdAt":"2022-11-14T14:22:32.374Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63724ff9d7005509ab075d72","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Create Refund Request","icon":"","type":"basic","slug":"c-full-sdk-create-refund-request","order":25,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-refund-request","createdAt":"2022-11-14T14:26:01.309Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"6372504b99f73b007752841a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get Refund Request","icon":"","type":"basic","slug":"c-full-sdk-get-refund-request","order":26,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-refund-request","createdAt":"2022-11-14T14:27:23.027Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"637254fed54bae0010e63509","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get All Refund Requests on Invoice","icon":"","type":"basic","slug":"c-full-sdk-get-all-refund-requests-on-invoice","order":27,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-all-refund-requests-on-invoice","createdAt":"2022-11-14T14:47:26.630Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63725527592a14001e3e8953","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Update a Refund","icon":"","type":"basic","slug":"c-full-sdk-update-a-refund","order":28,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"update-a-refund","createdAt":"2022-11-14T14:48:07.289Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63725547ed17570b285b8385","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Cancel a Refund","icon":"","type":"basic","slug":"c-full-sdk-cancel-a-refund","order":29,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"cancel-a-refund","createdAt":"2022-11-14T14:48:39.350Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"6372558ca8e6880de1b5fb2e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Request Refund Notification","icon":"","type":"basic","slug":"c-full-sdk-request-refund-notification","order":30,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"request-refund-notification","createdAt":"2022-11-14T14:49:48.762Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"6372564aa8e6880de1b603fc","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Retrieve Settlements","icon":"","type":"basic","slug":"c-full-sdk-retrieve-settlements","order":31,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"c-full-sdk-retrieve-a-settlement","createdAt":"2022-11-14T14:52:58.453Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63725692d7bed1000f2dd38d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Retrieve a Settlement by ID","icon":"","type":"basic","slug":"c-full-sdk-retrieve-a-settlement-by-id","order":32,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-a-settlement-by-id","createdAt":"2022-11-14T14:54:10.333Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"637256eb06a08b06c08dc7b3","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get Settlement Reconciliation Report","icon":"","type":"basic","slug":"c-full-sdk-get-settlement-reconciliation-report","order":33,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-settlement-reconciliation-report","createdAt":"2022-11-14T14:55:39.621Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"637257585019ef00105f1123","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get Supported Wallets","icon":"","type":"basic","slug":"c-full-sdk-get-supported-wallets","order":34,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-supported-wallets-1","createdAt":"2022-11-14T14:57:28.862Z","parentDoc":"63723c063556b70bb4956356","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]}]},{"_id":"636162f1148372009176fe3c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Java SDK","icon":"","type":"basic","slug":"java-full-sdk-getting-started","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"getting-started-with-the-full-java-sdk","createdAt":"2022-11-01T18:18:25.632Z","category":"63b72b6e460c60008573ad9a","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"6499a0429df8240487bf0fa4","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Java Full SDK (version < 9.0.0)","icon":"","type":"basic","slug":"java-full-sdk-version-900","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","createdAt":"2023-06-26T14:27:14.863Z","isBodyEmpty":false,"children":[]},{"_id":"63619aa42899c8005b3c4b0b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Create an Invoice","icon":"","type":"basic","slug":"java-full-sdk-create-an-invoice","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-an-invoice","createdAt":"2022-11-01T22:16:04.116Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"6369cadd67e71b01ba45585d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Retrieve an Invoice","icon":"","type":"basic","slug":"java-full-sdk-retrieve-an-invoice","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"java-full-sdk-retrieve-an-invoice-by-id","createdAt":"2022-11-08T03:19:57.564Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"6369d147b7424b0078404154","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Retrieve an Invoice by GUID","icon":"","type":"basic","slug":"java-full-sdk-retrieve-an-invoice-by-guid","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"636162f1148372009176fe3c","createdAt":"2022-11-08T03:47:19.764Z","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"6369cc6ae4bc570069afc2fe","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Retrieve Invoices","icon":"","type":"basic","slug":"java-full-sdk-retrieve-invoices","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-08T03:26:34.583Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"6369cec2246f0a00176afc87","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Update an Invoice","icon":"","type":"basic","slug":"java-full-sdk-update-an-invoice","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-08T03:36:34.773Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"6369d951e729b80033e4f638","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Cancel an Invoice","icon":"","type":"basic","slug":"java-full-sdk-cancel-an-invoice","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"636162f1148372009176fe3c","createdAt":"2022-11-08T04:21:37.379Z","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63f2c484dcd3760051119a3a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Cancel an Invoice by GUID","icon":"","type":"basic","slug":"java-full-sdk-cancel-an-invoice-by-guid","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"cancel-an-invoice-by-guid-1","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","createdAt":"2023-02-20T00:53:24.366Z","isBodyEmpty":false,"children":[]},{"_id":"6369d9be67e71b01ba4635f0","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Pay an Invoice","icon":"","type":"basic","slug":"java-full-sdk-pay-an-invoice","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-08T04:23:26.486Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63715bc83ef873000fc5940f","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Create a Refund","icon":"","type":"basic","slug":"java-full-sdk-create-a-refund","order":9,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"java-full-sdk-create-a-refund-request","createdAt":"2022-11-13T21:04:08.042Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"6393d4e56e441100761528bc","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Create a Refund with GUID","icon":"","type":"basic","slug":"create-a-refund-with-guid","order":10,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-a-refund-with-guid-request","parentDoc":"636162f1148372009176fe3c","createdAt":"2022-12-10T00:37:57.980Z","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"6393d56f092c4f0031f1b36b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Create a Refund by Object","icon":"","type":"basic","slug":"create-a-refund-by-object","order":11,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-a-refund-by-reference","parentDoc":"636162f1148372009176fe3c","createdAt":"2022-12-10T00:40:15.551Z","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"637163e2157276006b66e0ed","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Retrieve a Refund","icon":"","type":"basic","slug":"java-full-sdk-retrieve-a-refund","order":12,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"java-full-sdk-get-a-refund","createdAt":"2022-11-13T21:38:42.202Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"6393d63c1cf7fe00175592cf","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Retrieve a Refund by GUID","icon":"","type":"basic","slug":"retrieve-a-refund-by-guid","order":13,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-a-refund-by-guid","parentDoc":"636162f1148372009176fe3c","createdAt":"2022-12-10T00:43:40.146Z","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63716474b963f8009ba21981","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get All Refund Requests by Invoice ID","icon":"","type":"basic","slug":"java-full-sdk-get-all-refund-requests-by-invoice-id","order":14,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-all-refund-requests-by-invoice-id","createdAt":"2022-11-13T21:41:08.598Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63716544d8d67a0072ec12fc","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Update a Refund","icon":"","type":"basic","slug":"java-full-sdk-update-a-refund","order":15,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"update-a-refund","createdAt":"2022-11-13T21:44:36.566Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"6393d6a2d2595100177d421d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Update a Refund by GUID","icon":"","type":"basic","slug":"update-a-refund-by-guid","order":16,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"636162f1148372009176fe3c","createdAt":"2022-12-10T00:45:22.110Z","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"637165d5df581500168c247f","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Cancel a Refund","icon":"","type":"basic","slug":"java-full-sdk-cancel-a-refund","order":17,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"java-full-sdk-cancel-a-refund-request","createdAt":"2022-11-13T21:47:01.601Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"6393d768881ae300374acb2c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Cancel a Refund by GUID","icon":"","type":"basic","slug":"cancel-a-refund-by-guid","order":18,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"636162f1148372009176fe3c","createdAt":"2022-12-10T00:48:40.885Z","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"6371670d29c6680033709c13","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Request a Refund Notification","icon":"","type":"basic","slug":"java-full-sdk-request-a-refund-notification","order":19,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"request-a-refund-notification","createdAt":"2022-11-13T21:52:13.269Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"637a78b7272cab005ab5ba81","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Retrieve Settlements","icon":"","type":"basic","slug":"java-full-sdk-retrieve-settlements","order":20,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"java-full-sdk-retrieve-settlements-1","createdAt":"2022-11-20T18:57:59.291Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"637a79b25340170031fecbda","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Retrieve a Settlement","icon":"","type":"basic","slug":"java-full-sdk-retrieve-a-settlement","order":21,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"636162f1148372009176fe3c","createdAt":"2022-11-20T19:02:10.780Z","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"637a7a55a706710081024da0","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Fetch a Reconciliation Report","icon":"","type":"basic","slug":"java-full-sdk-fetch-a-reconciliation-report","order":22,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"636162f1148372009176fe3c","createdAt":"2022-11-20T19:04:53.807Z","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636b0b165980ee00a08c5c24","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Retrieve Account Balances","icon":"","type":"basic","slug":"java-full-sdk-retrieve-account-balances","order":23,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-account-balances","createdAt":"2022-11-09T02:06:14.790Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636b0bf9b5a93504f5de3e44","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Retrieve Ledger Entries","icon":"","type":"basic","slug":"java-full-sdk-retrieve-ledger-entries","order":24,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-ledger-entries","createdAt":"2022-11-09T02:10:01.032Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636c2d5175a86400905365f2","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Create Payout Recipients","icon":"","type":"basic","slug":"java-full-sdk-create-payout-recipients","order":25,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-payout-recipients","createdAt":"2022-11-09T22:44:33.128Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636c45f76ee49a002ac00c77","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get Payout Recipient","icon":"","type":"basic","slug":"java-full-sdk-get-payout-recipient","order":26,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-payout-recipient","createdAt":"2022-11-10T00:29:43.489Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636c46f7e2509d00689a1cd5","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get Payout Recipients","icon":"","type":"basic","slug":"java-full-sdk-get-payout-recipients","order":27,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-payout-recipients","createdAt":"2022-11-10T00:33:59.634Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636c4a908074bc00a6b2e3f1","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Update Payout Recipient","icon":"","type":"basic","slug":"java-full-sdk-update-payout-recipient","order":28,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"update-payout-recipient","createdAt":"2022-11-10T00:49:20.992Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636c4b322ee1f500471df4eb","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Delete Payout Recipient","icon":"","type":"basic","slug":"java-full-sdk-delete-payout-recipient","order":29,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"delete-payout-recipient","createdAt":"2022-11-10T00:52:02.450Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636c4dbd212e49001e83da51","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Request Payout Recipient Notification","icon":"","type":"basic","slug":"java-full-sdk-request-payout-recipient-notification","order":30,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"request-payout-recipient-notification","createdAt":"2022-11-10T01:02:53.042Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636c4c238c700b001e2dbf7a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Recipient Webhooks","icon":"","type":"basic","slug":"java-full-sdk-recipient-webhooks","order":31,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"recipient-webhooks","createdAt":"2022-11-10T00:56:03.661Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636e8c7481dfbf009666a7f4","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Create Payout Request","icon":"","type":"basic","slug":"java-full-sdk-create-payout-request","order":32,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"java-full-sdk-create-payout-recipient","createdAt":"2022-11-11T17:55:00.930Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"6537305b0cef680063587f18","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Create Payout Group","icon":"","type":"basic","slug":"java-full-sdk-create-payout-group","order":33,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","createdAt":"2023-10-24T02:47:55.984Z","isBodyEmpty":false,"children":[]},{"_id":"653730784b3fbe0013e132bc","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Cancel a Payout Group","icon":"","type":"basic","slug":"java-full-sdk-cancel-a-payout-group","order":34,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","createdAt":"2023-10-24T02:48:24.648Z","isBodyEmpty":false,"children":[]},{"_id":"636e8ce98344490a1b261f12","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get Payout by ID","icon":"","type":"basic","slug":"java-full-sdk-get-payout-by-id","order":35,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-payout-by-id","createdAt":"2022-11-11T17:56:57.721Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636e8db49cdf9b0017adbe84","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get Payouts","icon":"","type":"basic","slug":"java-full-sdk-get-payouts","order":36,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-payouts","createdAt":"2022-11-11T18:00:20.237Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636e8e985ea2200032d9bc7c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Cancel Payout","icon":"","type":"basic","slug":"java-full-sdk-cancel-payout","order":37,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"cancel-payout","createdAt":"2022-11-11T18:04:08.307Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636e8efeacdcbf0010f854bf","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Request Payout Notification","icon":"","type":"basic","slug":"java-full-sdk-request-payout-notification","order":38,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"java-full-sdk-request-payout-notification-1","createdAt":"2022-11-11T18:05:50.646Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636e8fb0e969370073e3b5a6","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Payout Webhooks","icon":"","type":"basic","slug":"java-full-sdk-payout-webhooks","order":39,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"payout-webhooks","createdAt":"2022-11-11T18:08:48.655Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636eaf0882ab8100a29c7f0d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Create a Bill","icon":"","type":"basic","slug":"java-full-sdk-create-a-bill","order":40,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-a-bill","createdAt":"2022-11-11T20:22:32.147Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636eaf1d855221001e49f1d6","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Retrieve a Bill","icon":"","type":"basic","slug":"java-full-sdk-retrieve-a-bill","order":41,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"java-full-sdk-retrieve-a-bill-by-id","createdAt":"2022-11-11T20:22:53.749Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636eb0dfd7fcc4008089ba7d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Retrieve Bills","icon":"","type":"basic","slug":"retrieve-bills","order":42,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"636162f1148372009176fe3c","createdAt":"2022-11-11T20:30:23.088Z","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636eb015a62cf40029714b46","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Retrieve Bills by Status","icon":"","type":"basic","slug":"java-full-sdk-retrieve-bills-by-status","order":43,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"java-full-sdk-retrieve-bills","createdAt":"2022-11-11T20:27:01.193Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636eaf3110035a00973cd0cd","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Update a Bill","icon":"","type":"basic","slug":"java-full-sdk-update-a-bill","order":44,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"update-a-bill","createdAt":"2022-11-11T20:23:13.365Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636eaf44a6243700391be173","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Deliver a Bill","icon":"","type":"basic","slug":"java-full-sdk-deliver-a-bill","order":45,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"deliver-a-bill","createdAt":"2022-11-11T20:23:32.119Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"6369db8ff6eb1c000f3f3925","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get Exchange Rates","icon":"","type":"basic","slug":"java-full-sdk-get-exchange-rates","order":46,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-08T04:31:11.668Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636b27efc61e6a0032a37a4b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Retrieve Supported Wallets","icon":"","type":"basic","slug":"java-full-sdk-retrieve-supported-wallets","order":47,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-supported-wallets","createdAt":"2022-11-09T04:09:19.955Z","parentDoc":"636162f1148372009176fe3c","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]}]},{"_id":"636bb599e4a848062519dd90","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Node SDK","icon":"","type":"basic","slug":"node-full-sdk-getting-started","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-09T14:13:45.273Z","category":"63b72b6e460c60008573ad9a","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"64f126b9d27ddc004913a097","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Node Full SDK (version < 5.0.0)","icon":"","type":"basic","slug":"node-sdk-500","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","createdAt":"2023-08-31T23:48:09.291Z","isBodyEmpty":false,"children":[]},{"_id":"636bb65b2a0553006c736762","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Create an Invoice","icon":"","type":"basic","slug":"node-full-sdk-create-an-invoice","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-an-invoice","createdAt":"2022-11-09T14:16:59.224Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636bb67c76da5905e88c0989","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Retrieve an Invoice","icon":"","type":"basic","slug":"node-full-sdk-retrieve-an-invoice","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-an-invoice","createdAt":"2022-11-09T14:17:32.899Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"665de36b71a50800627ded86","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Retrieve an Invoice by GUID","icon":"","type":"basic","slug":"node-full-sdk-retrieve-an-invoice-by-guid","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-an-invoice-copy","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","createdAt":"2024-06-03T15:38:19.834Z","isBodyEmpty":false,"children":[]},{"_id":"665de41e6a05ff001e51cd7e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Retrieve Invoices","icon":"","type":"basic","slug":"node-full-sdk-retrieve-invoices","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-an-invoice-by-guid-copy","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","createdAt":"2024-06-03T15:41:18.906Z","isBodyEmpty":false,"children":[]},{"_id":"665de55413d280001ed4569b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Update an Invoice","icon":"","type":"basic","slug":"nodejs-full-sdk-update-an-invoice","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-invoices-copy","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","createdAt":"2024-06-03T15:46:28.940Z","isBodyEmpty":false,"children":[]},{"_id":"665de5e2a3a7b8002b8269ca","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Cancel an Invoice","icon":"","type":"basic","slug":"nodejs-full-sdk-cancel-an-invoice","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"update-an-invoice-copy","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","createdAt":"2024-06-03T15:48:50.893Z","isBodyEmpty":false,"children":[]},{"_id":"665de62e9976720063c7d85c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Cancel an Invoice by GUID","icon":"","type":"basic","slug":"nodejs-full-sdk-cancel-an-invoice-by-guid","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"cancel-an-invoice-copy","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","createdAt":"2024-06-03T15:50:06.692Z","isBodyEmpty":false,"children":[]},{"_id":"665de868a67da4005245be30","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Pay an Invoice","icon":"","type":"basic","slug":"nodejs-full-sdk-pay-an-invoice","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"cancel-an-invoice-by-guid-copy","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","createdAt":"2024-06-03T15:59:36.973Z","isBodyEmpty":false,"children":[]},{"_id":"636cf2b00fdebc005643bb43","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Create Refund Request","icon":"","type":"basic","slug":"node-full-sdk-create-refund-request","order":9,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-refund-request","createdAt":"2022-11-10T12:46:40.985Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636cf2d543757a0082f26339","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Get Refund","icon":"","type":"basic","slug":"node-full-sdk-get-refund","order":10,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"node-full-sdk-get-refund-request","createdAt":"2022-11-10T12:47:17.686Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"665df1762183ef004fe4c083","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Get Refund by GUID","icon":"","type":"basic","slug":"nodejs-full-sdk-get-refund-by-guid","order":11,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-refund-request-copy","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","createdAt":"2024-06-03T16:38:14.250Z","isBodyEmpty":false,"children":[]},{"_id":"636cf36be13d9301c2c8a46f","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Get All Refunds on Invoice","icon":"","type":"basic","slug":"node-full-sdk-get-all-refunds-on-invoice","order":12,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"node-full-sdk-get-all-refund-requests-on-invoice","createdAt":"2022-11-10T12:49:47.744Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"665e0a14127a750012e57bbb","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Update Refund","icon":"","type":"basic","slug":"nodejs-full-sdk-update-refund","order":13,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-all-refunds-on-invoice-copy","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","createdAt":"2024-06-03T18:23:16.317Z","isBodyEmpty":false,"children":[]},{"_id":"665e0a6a2d4a7c004fba9a1b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Update Refund by GUID","icon":"","type":"basic","slug":"nodejs-full-sdk-update-refund-by-guid","order":14,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"update-refund-copy","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","createdAt":"2024-06-03T18:24:42.739Z","isBodyEmpty":false,"children":[]},{"_id":"636cf38ef7ae1e00a155c0dc","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Cancel Refund","icon":"","type":"basic","slug":"node-full-sdk-cancel-refund","order":15,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"node-full-sdk-cancel-refund-request","createdAt":"2022-11-10T12:50:22.512Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"665e0ae97fbc14005e29502f","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Cancel Refund by GUID","icon":"","type":"basic","slug":"nodejs-full-sdk-cancel-refund-by-guid","order":16,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"cancel-refund-copy","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","createdAt":"2024-06-03T18:26:49.225Z","isBodyEmpty":false,"children":[]},{"_id":"636cf3cd267da807f013989b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Request Refund Notification","icon":"","type":"basic","slug":"node-full-sdk-request-refund-notification","order":17,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"request-refund-notification","createdAt":"2022-11-10T12:51:25.455Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636cf48dcd8205018670065d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Get Settlements","icon":"","type":"basic","slug":"node-full-sdk-get-settlements","order":18,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-settlements","createdAt":"2022-11-10T12:54:37.236Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636cf4b098298504d0d032ef","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Get Settlement by ID","icon":"","type":"basic","slug":"node-full-sdk-get-settlement-by-id","order":19,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-settlement-by-id","createdAt":"2022-11-10T12:55:12.944Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636cf4e4ea38c60ab4de0705","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Get Settlement Reconciliation Export","icon":"","type":"basic","slug":"node-full-sdk-get-settlement-reconciliation-export","order":20,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-settlement-reconciliation-export","createdAt":"2022-11-10T12:56:04.273Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"6661e966ba0672003056e3c2","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Retrieve Account Balances","icon":"","type":"basic","slug":"nodejfull-sdk-retrieve-account-balances","order":21,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"nodejs-full-sdk-retrieve-account-balances","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","createdAt":"2024-06-06T16:52:54.735Z","isBodyEmpty":false,"children":[]},{"_id":"636c02a94b5c8910d54db0ee","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Retrieve Ledger Entries","icon":"","type":"basic","slug":"node-full-sdk-retrieve-ledger-entries","order":22,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"node-full-sdk-get-ledger","createdAt":"2022-11-09T19:42:33.736Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636c0e3ebcb1b0000f6f69ba","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Create Payout Recipients","icon":"","type":"basic","slug":"node-full-sdk-create-payout-recipients","order":23,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-payout-recipients","createdAt":"2022-11-09T20:31:58.055Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636c0e7888ed5d00175b8371","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Get Payout Recipient","icon":"","type":"basic","slug":"node-full-sdk-get-payout-recipient","order":24,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-payout-recipient","createdAt":"2022-11-09T20:32:56.874Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636c0eb80e3cfe008a7523b2","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Get Payout Recipients","icon":"","type":"basic","slug":"node-full-sdk-get-payout-recipients","order":25,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-payout-recipients","createdAt":"2022-11-09T20:34:00.388Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636c0f04e2509d0068923af5","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Update Payout Recipients","icon":"","type":"basic","slug":"node-full-sdk-update-payout-recipients","order":26,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"update-payout-recipients","createdAt":"2022-11-09T20:35:16.133Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636c0f4efcc97f0071793a36","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Delete Payout Recipient","icon":"","type":"basic","slug":"node-full-sdk-delete-payout-recipient","order":27,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"delete-payout-recipient","createdAt":"2022-11-09T20:36:30.055Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636c0f9a0ef10b0029a2690b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Request Payout Recipient Notification","icon":"","type":"basic","slug":"node-full-sdk-request-payout-recipient-notification","order":28,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"request-payout-recipient-notification","createdAt":"2022-11-09T20:37:46.232Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636c0fbbaf8b12004eab2bd3","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Recipient Webhooks","icon":"","type":"basic","slug":"node-full-sdk-recipient-webhooks","order":29,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"recipient-webhooks","createdAt":"2022-11-09T20:38:19.751Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636c109c239f050016c52b77","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Create Payout Request","icon":"","type":"basic","slug":"node-full-sdk-create-payout-request","order":30,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-payout-request","createdAt":"2022-11-09T20:42:04.650Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"6661f45e29d2dd00127fbfb1","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Create Payout Group","icon":"","type":"basic","slug":"node-full-sdk-create-payout-group","order":31,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-payout-request-copy","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","createdAt":"2024-06-06T17:39:42.960Z","isBodyEmpty":false,"children":[]},{"_id":"6661f4e4e1311d00176f56f3","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Cancel a Payout Group","icon":"","type":"basic","slug":"node-full-sdk-cancel-a-payout-group","order":32,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-payout-group-copy","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","createdAt":"2024-06-06T17:41:56.062Z","isBodyEmpty":false,"children":[]},{"_id":"636c114b7ef106000f1076fa","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Get Payout by ID","icon":"","type":"basic","slug":"node-full-sdk-get-payout","order":33,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-payout","createdAt":"2022-11-09T20:44:59.216Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"6661f5dac7ae1b005910fa28","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Get Payouts","icon":"","type":"basic","slug":"node-full-sdk-get-payouts","order":34,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-payout-by-id-copy","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","createdAt":"2024-06-06T17:46:02.870Z","isBodyEmpty":false,"children":[]},{"_id":"636c11f091ee36008e803f61","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Cancel Payouts","icon":"","type":"basic","slug":"node-full-sdk-cancel-payouts","order":35,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"cancel-payouts","createdAt":"2022-11-09T20:47:44.975Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636c12673aa0a90017162604","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Request Payout Notification","icon":"","type":"basic","slug":"node-full-sdk-request-payout-notification","order":36,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"request-payout-notification-1","createdAt":"2022-11-09T20:49:43.726Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636c13193f4471002d0ed19c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Payout Webhooks","icon":"","type":"basic","slug":"node-full-sdk-payout-webhooks","order":37,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"payout-webhooks","createdAt":"2022-11-09T20:52:41.558Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636bb6efa9831e0086ce8b5d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Create Bill","icon":"","type":"basic","slug":"node-full-sdk-create-bill","order":38,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-bill","createdAt":"2022-11-09T14:19:27.532Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636bb7c39f55880b9dd098b6","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Retrieve a Bill","icon":"","type":"basic","slug":"node-full-sdk-get-bill","order":39,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-bill","createdAt":"2022-11-09T14:22:59.496Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"6661f7bab84290001886420e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Retrieve Bills by Status","icon":"","type":"basic","slug":"node-full-sdk-retrieve-bills-by-status","order":40,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-a-bill-copy","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","createdAt":"2024-06-06T17:54:02.678Z","isBodyEmpty":false,"children":[]},{"_id":"6661f812799a9b006bd60b25","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Update a Bill","icon":"","type":"basic","slug":"node-full-sdk-update-a-bill","order":41,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"deliver-bill-copy","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","createdAt":"2024-06-06T17:55:30.222Z","isBodyEmpty":false,"children":[]},{"_id":"636bb8979f55880b9dd0a2c6","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Deliver Bill","icon":"","type":"basic","slug":"node-full-sdk-deliver-bill","order":42,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"deliver-bill","createdAt":"2022-11-09T14:26:31.556Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636cf2281dfbc5045d253482","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Get Exchange Rates","icon":"","type":"basic","slug":"node-full-sdk-get-exchange-rates","order":43,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-exchange-rates","createdAt":"2022-11-10T12:44:24.557Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636cf257c2e8080d97917caf","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Get Currencies","icon":"","type":"basic","slug":"node-full-sdk-get-currencies","order":44,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-currencies","createdAt":"2022-11-10T12:45:11.503Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636cf40ae2d53c000fd2ed6e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Get Supported Wallets","icon":"","type":"basic","slug":"get-supported-wallets","order":45,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-10T12:52:26.051Z","parentDoc":"636bb599e4a848062519dd90","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]}]},{"_id":"63655380385ff20053329950","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"PHP SDK","icon":"","type":"basic","slug":"php-full-sdk-getting-started","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-04T18:01:36.938Z","category":"63b72b6e460c60008573ad9a","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"649b941feda74c022eb2f4c0","api":{"method":"get","url":"","auth":"required","params":[]},"title":"PHP Full SDK (version < 8.0.0)","icon":"","type":"basic","slug":"php-full-sdk-version-800","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","createdAt":"2023-06-28T01:59:59.477Z","isBodyEmpty":false,"children":[]},{"_id":"63656854785ab1009272d1c4","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Create an Invoice","icon":"","type":"basic","slug":"php-full-sdk-create-an-invoice","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-04T19:30:28.646Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"6365689c7e6dbd000fba347f","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Retrieve an Invoice","icon":"","type":"basic","slug":"php-full-sdk-retrieve-an-invoice","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-04T19:31:40.526Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"64cb074126bc7500123514fd","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Retrieve an Invoice by GUID","icon":"","type":"basic","slug":"retrieve-an-invoice-by-guid-1","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","createdAt":"2023-08-03T01:47:45.150Z","isBodyEmpty":false,"children":[]},{"_id":"637a9a0975e0d200748fa6c3","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Retrieve Invoices","icon":"","type":"basic","slug":"php-full-sdk-retrieve-invoices","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-invoices","createdAt":"2022-11-20T21:20:09.655Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"64cb09f2ec323b002aeece00","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Update an Invoice","icon":"","type":"basic","slug":"update-an-invoice-1","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","createdAt":"2023-08-03T01:59:14.845Z","isBodyEmpty":false,"children":[]},{"_id":"63f2c67bc92b130033df148e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Cancel an Invoice","icon":"","type":"basic","slug":"php-full-sdk-cancel-an-invoice","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","createdAt":"2023-02-20T01:01:47.747Z","isBodyEmpty":false,"children":[]},{"_id":"63f2c734320d33005ebad457","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Cancel an Invoice by GUID","icon":"","type":"basic","slug":"php-full-sdk-cancel-an-invoice-by-guid","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"cancel-an-invoice-by-guid-1","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","createdAt":"2023-02-20T01:04:52.606Z","isBodyEmpty":false,"children":[]},{"_id":"636568d7aa796a00883ef726","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Pay an Invoice","icon":"","type":"basic","slug":"php-full-sdk-pay-an-invoice","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"pay-an-invoice","createdAt":"2022-11-04T19:32:39.651Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636aa4cddab5400b772d4732","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Create a new refund request","icon":"","type":"basic","slug":"php-full-sdk-create-a-new-refund-request","order":9,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-a-new-refund-request","createdAt":"2022-11-08T18:49:49.636Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636aa509bc7a6a0072ae9f9e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get existing refund request","icon":"","type":"basic","slug":"php-full-sdk-get-existing-refund-request","order":10,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-existing-refund-request","createdAt":"2022-11-08T18:50:49.558Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636aa5a3b70c7e04c96d2a06","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get all refund requests on an Invoice","icon":"","type":"basic","slug":"php-full-sdk-get-all-refund-requests-on-an-invoice","order":11,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-all-refund-requests-on-an-invoice","createdAt":"2022-11-08T18:53:23.639Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636aa5c6b9d44b06a665b62a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Update Refund Request","icon":"","type":"basic","slug":"php-full-sdk-update-refund-request","order":12,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"update-refund-request","createdAt":"2022-11-08T18:53:58.344Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636aa5e759e7fd0088022cd5","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Cancel Refund Request","icon":"","type":"basic","slug":"php-full-sdk-cancel-refund-request","order":13,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"cancel-refund-request","createdAt":"2022-11-08T18:54:31.865Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636aa61eefab95005c35df30","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Request Refund Notification","icon":"","type":"basic","slug":"php-full-sdk-request-refund-notification","order":14,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"request-refund-notification","createdAt":"2022-11-08T18:55:26.080Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636aa3cd32c75e0048561184","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get Settlements","icon":"","type":"basic","slug":"php-full-sdk-get-settlements","order":15,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-settlements","createdAt":"2022-11-08T18:45:33.914Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636aa3f1dd3c990144ba2e53","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get Settlement by ID","icon":"","type":"basic","slug":"php-full-sdk-get-settlement","order":16,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-settlement","createdAt":"2022-11-08T18:46:09.665Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636aa41e786897003aaa4c69","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Get Settlement Reconciliation Report","icon":"","type":"basic","slug":"php-full-sdk-get-settlement-reconciliation-report","order":17,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-settlement-reconciliation-report","createdAt":"2022-11-08T18:46:54.620Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636aaf5c083b0314a6e90bb9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Retrieve Account Balances","icon":"","type":"basic","slug":"php-full-sdk-retrieve-account-balances","order":18,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"php-full-sdk-get-ledgers","createdAt":"2022-11-08T19:34:52.074Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"637ab213453d580081caf3d2","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Retrieve Ledger Entries","icon":"","type":"basic","slug":"php-full-sdk-retrieve-ledger-entries","order":19,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"php-full-sdk-retrieve-account-balances","createdAt":"2022-11-20T23:02:43.556Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636aacbda2e7b40dabecf402","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Create Payout Recipients","icon":"","type":"basic","slug":"php-full-sdk-create-payout-recipients","order":20,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-payout-recipients","createdAt":"2022-11-08T19:23:41.136Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636aacee67e71b01ba55815b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get Payout Recipient","icon":"","type":"basic","slug":"php-full-sdk-get-payout-recipient","order":21,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-payout-recipient","createdAt":"2022-11-08T19:24:30.698Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636aae1620f6a507415e7255","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get Payout Recipients","icon":"","type":"basic","slug":"php-full-sdk-get-payout-recipients","order":22,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-payout-recipients","createdAt":"2022-11-08T19:29:26.777Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636aae3982ef270ee63353dd","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Update Payout Recipient","icon":"","type":"basic","slug":"php-full-sdk-update-payout-recipient","order":23,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"update-payout-recipient","createdAt":"2022-11-08T19:30:01.877Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636aae91e1198d009d908615","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Delete Payout Recipient","icon":"","type":"basic","slug":"php-full-sdk-delete-payout-recipient","order":24,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"delete-payout-recipient","createdAt":"2022-11-08T19:31:29.656Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63841d765f9ef20093f25ce1","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Request Payout Recipient Notification","icon":"","type":"basic","slug":"php-full-sdk-request-payout-recipient-notification","order":25,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"request-payout-recipient-notification","createdAt":"2022-11-28T02:31:18.079Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636aaeaf17daec0d6bf4a54d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Recipient Webhooks","icon":"","type":"basic","slug":"php-full-sdk-recipient-webhooks","order":26,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"recipient-webhooks","createdAt":"2022-11-08T19:31:59.131Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636aa85551603e006be8a98f","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Create Payout Request","icon":"","type":"basic","slug":"php-full-sdk-create-payout-request","order":27,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-payout-request","createdAt":"2022-11-08T19:04:53.648Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"65372ab9d261ed002e4ee527","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Create Payout Group","icon":"","type":"basic","slug":"php-full-sdk-create-payout-group","order":28,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-payout-group-1","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","createdAt":"2023-10-24T02:23:53.945Z","isBodyEmpty":false,"children":[]},{"_id":"65372ac221107400601b85ed","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Cancel a Payout Group","icon":"","type":"basic","slug":"php-full-sdk-cancel-a-payout-group","order":29,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"php-cancel-a-payout-group-request","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","createdAt":"2023-10-24T02:24:02.160Z","isBodyEmpty":false,"children":[]},{"_id":"636aa8eea6bbc60131249ba6","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Get Payout by ID","icon":"","type":"basic","slug":"php-full-sdk-get-payout-by-id","order":30,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"php-full-sdk-get-payout","createdAt":"2022-11-08T19:07:26.896Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636aa91217daec0d6bf42a40","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get Payouts","icon":"","type":"basic","slug":"php-full-sdk-get-payouts","order":31,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-payouts","createdAt":"2022-11-08T19:08:02.481Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636aa92d20f6a507415e20a7","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Cancel Payouts","icon":"","type":"basic","slug":"php-full-sdk-cancel-payouts","order":32,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"cancel-payouts","createdAt":"2022-11-08T19:08:29.467Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636aa9511f549900325cb247","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Request Payout Notification","icon":"","type":"basic","slug":"request-payout-notification","order":33,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-08T19:09:05.530Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636aa973a574ff056af8f126","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Payout Webhooks","icon":"","type":"basic","slug":"php-full-sdk-payout-webhooks","order":34,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"payout-webhooks","createdAt":"2022-11-08T19:09:39.411Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636ab0586bf0860031d15b0b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Create Bill","icon":"","type":"basic","slug":"php-full-sdk-create-bill","order":35,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-bill","createdAt":"2022-11-08T19:39:04.371Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636ab077728c6c0023659aca","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Retrieve a Bill","icon":"","type":"basic","slug":"php-full-sdk-retrieve-a-bill","order":36,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"php-full-sdk-get-bill","createdAt":"2022-11-08T19:39:35.806Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"6384208035ef2d01b209f57d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Retrieve Bills by Status","icon":"","type":"basic","slug":"php-full-sdk-retrieve-bills-by-status","order":37,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-bills-1","createdAt":"2022-11-28T02:44:16.806Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"638423230d2e61003b12ce5a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Update a Bill","icon":"","type":"basic","slug":"php-full-sdk-update-a-bill","order":38,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"update-a-bill-1","createdAt":"2022-11-28T02:55:31.154Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636ab099ec69c6000f486046","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Deliver Bill","icon":"","type":"basic","slug":"php-full-sdk-deliver-bill","order":39,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"deliver-bill","createdAt":"2022-11-08T19:40:09.012Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636aa67288a380001876e412","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get Exchange Rates","icon":"","type":"basic","slug":"php-full-sdk-get-exchange-rates","order":40,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-exchange-rates","createdAt":"2022-11-08T18:56:50.338Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636aa69220e9cd000f12ffa7","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get Currencies","icon":"","type":"basic","slug":"php-full-sdk-get-currencies","order":41,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-currencies","createdAt":"2022-11-08T18:57:22.217Z","parentDoc":"63655380385ff20053329950","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]}]},{"_id":"65777224b173a300488689bf","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Python SDK","icon":"","type":"basic","slug":"python-sdk","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-11T20:33:40.831Z","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"6577724d557d39002f7fa2e8","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Create an Invoice","icon":"","type":"basic","slug":"python-sdk-create-an-invoice","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-an-invoice-1","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-11T20:34:21.623Z","isBodyEmpty":false,"children":[]},{"_id":"6580ae3081337d00651179bd","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Retrieve an Invoice","icon":"","type":"basic","slug":"python-sdk-retrieve-an-invoice","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-an-invoice-1","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-18T20:40:16.029Z","isBodyEmpty":false,"children":[]},{"_id":"6580ae996c891f0010dc983e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Retrieve an Invoice by GUID","icon":"","type":"basic","slug":"python-sdk-retrieve-an-invoice-by-guid","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-18T20:42:01.106Z","isBodyEmpty":false,"children":[]},{"_id":"6580aef9cceb2d00546815b6","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Retrieve Invoices","icon":"","type":"basic","slug":"python-sdk-retrieve-invoices","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-18T20:43:37.234Z","isBodyEmpty":false,"children":[]},{"_id":"6580b11f54911d0023178d0e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Update an Invoice","icon":"","type":"basic","slug":"python-sdk-update-an-invoice","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-18T20:52:47.839Z","isBodyEmpty":false,"children":[]},{"_id":"6581fe8f3cce66006f615d6d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Cancel an Invoice","icon":"","type":"basic","slug":"python-sdk-cancel-an-invoice","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T20:35:27.360Z","isBodyEmpty":false,"children":[]},{"_id":"6581fec4ff384f0060c7073d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Cancel an Invoice by GUID","icon":"","type":"basic","slug":"python-sdk-cancel-an-invoice-by-guid","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T20:36:20.318Z","isBodyEmpty":false,"children":[]},{"_id":"6581fef3959d54007dada016","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Pay an Invoice","icon":"","type":"basic","slug":"python-sdk-pay-an-invoice","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"pay-an-invoice","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T20:37:07.598Z","isBodyEmpty":false,"children":[]},{"_id":"6581ff40f37312007123ebd5","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Create a new refund request","icon":"","type":"basic","slug":"python-sdk-create-a-new-refund-request","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-a-new-refund-request","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T20:38:24.186Z","isBodyEmpty":false,"children":[]},{"_id":"65820002138b370055293f8b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Get existing refund request","icon":"","type":"basic","slug":"python-sdk-get-existing-refund-request","order":9,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-existing-refund-request","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T20:41:38.812Z","isBodyEmpty":false,"children":[]},{"_id":"65820043bc2d49006211633a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Get all refund requests on an Invoice","icon":"","type":"basic","slug":"python-sdk-get-all-refund-requests-on-an-invoice","order":10,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-all-refund-requests-on-an-invoice","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T20:42:43.948Z","isBodyEmpty":false,"children":[]},{"_id":"6582008042ea80000ea41c7e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Update Refund Request","icon":"","type":"basic","slug":"python-sdk-update-refund-request","order":11,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"update-refund-request","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T20:43:44.940Z","isBodyEmpty":false,"children":[]},{"_id":"65f619bed477f8004aff7afb","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Update Refund Request by GUID","icon":"","type":"basic","slug":"update-refund-request-copy","order":12,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2024-03-16T22:14:22.851Z","isBodyEmpty":false,"children":[]},{"_id":"658200af5b3ab000100b14f8","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Cancel Refund Request","icon":"","type":"basic","slug":"python-sdk-cancel-refund-request","order":13,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"cancel-refund-request","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T20:44:31.642Z","isBodyEmpty":false,"children":[]},{"_id":"65f619ee60d6b00046010907","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Cancel Refund Request by GUID","icon":"","type":"basic","slug":"cancel-refund-request-copy","order":14,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2024-03-16T22:15:10.972Z","isBodyEmpty":false,"children":[]},{"_id":"65820149731e56001c65952f","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Request Refund Notification","icon":"","type":"basic","slug":"python-sdk-request-refund-notification","order":15,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"request-refund-notification","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T20:47:05.756Z","isBodyEmpty":false,"children":[]},{"_id":"6582109f2219b60024a7a714","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Get Settlements","icon":"","type":"basic","slug":"python-sdk-get-settlements","order":16,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-settlements","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T21:52:31.591Z","isBodyEmpty":false,"children":[]},{"_id":"658210ca87b86d000f1d15d1","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Get Settlement by ID","icon":"","type":"basic","slug":"python-sdk-get-settlement-by-id","order":17,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-settlement-by-id","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T21:53:14.280Z","isBodyEmpty":false,"children":[]},{"_id":"6582111787177d0046983f3e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Get Settlement Reconciliation Report","icon":"","type":"basic","slug":"python-sdk-get-settlement-reconciliation-report","order":18,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-settlement-reconciliation-report","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T21:54:31.224Z","isBodyEmpty":false,"children":[]},{"_id":"658211492d9e570023d3a606","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Retrieve Account Balances","icon":"","type":"basic","slug":"python-sdk-retrieve-account-balances","order":19,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"python-sdk-retrieve-account-balances-1","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T21:55:21.497Z","isBodyEmpty":false,"children":[]},{"_id":"658211c027164a0016e97a56","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Retrieve Ledger Entries","icon":"","type":"basic","slug":"python-sdk-retrieve-ledger-entries","order":20,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-ledger-entries-1","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T21:57:20.203Z","isBodyEmpty":false,"children":[]},{"_id":"658211ff023cd2005eaa1a86","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Create Payout Recipients","icon":"","type":"basic","slug":"python-sdk-create-payout-recipients","order":21,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-payout-recipients","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T21:58:23.738Z","isBodyEmpty":false,"children":[]},{"_id":"6582122ceb30ac005bfe46db","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Get Payout Recipient","icon":"","type":"basic","slug":"python-sdk-get-payout-recipient","order":22,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-payout-recipient","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T21:59:08.559Z","isBodyEmpty":false,"children":[]},{"_id":"65821260b7e2ae00545af52e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Get Payout Recipients","icon":"","type":"basic","slug":"python-sdk-get-payout-recipients","order":23,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-payout-recipients","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T22:00:00.201Z","isBodyEmpty":false,"children":[]},{"_id":"6582129043273f003247e2ad","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Update Payout Recipient","icon":"","type":"basic","slug":"python-sdk-update-payout-recipient","order":24,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"update-payout-recipient","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T22:00:48.248Z","isBodyEmpty":false,"children":[]},{"_id":"658212bd5bfddc007716e93c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Delete Payout Recipient","icon":"","type":"basic","slug":"python-sdk-delete-payout-recipient","order":25,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"delete-payout-recipient","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T22:01:33.695Z","isBodyEmpty":false,"children":[]},{"_id":"658212eef373120071240359","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Request Payout Recipient Notification","icon":"","type":"basic","slug":"python-sdk-request-payout-recipient-notification","order":26,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"request-payout-recipient-notification","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T22:02:22.623Z","isBodyEmpty":false,"children":[]},{"_id":"65821330e914ea0079c83b24","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Recipient Webhooks","icon":"","type":"basic","slug":"python-sdk-recipient-webhooks","order":27,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"recipient-webhooks","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T22:03:28.606Z","isBodyEmpty":false,"children":[]},{"_id":"6582135f60c46900109a2d93","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Create Payout Request","icon":"","type":"basic","slug":"python-sdk-create-payout-request","order":28,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-payout-request","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T22:04:15.634Z","isBodyEmpty":false,"children":[]},{"_id":"658213b29a00e6001012cc9d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Create Payout Group","icon":"","type":"basic","slug":"python-sdk-create-payout-group","order":29,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-payout-group-1","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T22:05:38.346Z","isBodyEmpty":false,"children":[]},{"_id":"658213fc295df4000fd2d2d0","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Cancel a Payout Group","icon":"","type":"basic","slug":"python-sdk-cancel-a-payout-group","order":30,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"cancel-a-payout-group-1","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T22:06:52.783Z","isBodyEmpty":false,"children":[]},{"_id":"65821432b9f77400345746d2","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Get Payout by ID","icon":"","type":"basic","slug":"python-sdk-get-payout-by-id","order":31,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-payout-by-id","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T22:07:46.115Z","isBodyEmpty":false,"children":[]},{"_id":"6582147030e7a5001c0584c8","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Get Payouts","icon":"","type":"basic","slug":"python-sdk-get-payouts","order":32,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-payouts","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T22:08:48.653Z","isBodyEmpty":false,"children":[]},{"_id":"658214aafc5926006d968d3c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Cancel Payouts","icon":"","type":"basic","slug":"python-sdk-cancel-payouts","order":33,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"cancel-payouts","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T22:09:46.756Z","isBodyEmpty":false,"children":[]},{"_id":"658214d50f1c6c003f3e1c86","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Request Payout Notification","icon":"","type":"basic","slug":"python-sdk-request-payout-notification","order":34,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"request-payout-notification-2","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T22:10:29.639Z","isBodyEmpty":false,"children":[]},{"_id":"6582150af8ee230079fd5ba6","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Payout Webhooks","icon":"","type":"basic","slug":"python-sdk-payout-webhooks","order":35,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"payout-webhooks","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T22:11:22.710Z","isBodyEmpty":false,"children":[]},{"_id":"6582154b40cbce002af2b560","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Create Bill","icon":"","type":"basic","slug":"python-sdk-create-bill","order":36,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-bill","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-19T22:12:27.557Z","isBodyEmpty":false,"children":[]},{"_id":"6585b27732bcde0010839d72","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Retrieve a Bill","icon":"","type":"basic","slug":"python-sdk-retrieve-a-bill","order":37,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-a-bill-1","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-22T15:59:51.835Z","isBodyEmpty":false,"children":[]},{"_id":"6585b2b61839960050fc9ad4","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Retrieve Bills by Status","icon":"","type":"basic","slug":"python-sdk-retrieve-bills-by-status","order":38,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-bills-by-status-1","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-22T16:00:54.530Z","isBodyEmpty":false,"children":[]},{"_id":"6585b2f0926ed3001c82fbbc","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Update a Bill","icon":"","type":"basic","slug":"python-sdk-update-a-bill","order":39,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"update-a-bill-1","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-22T16:01:52.612Z","isBodyEmpty":false,"children":[]},{"_id":"6585b31de07e130056b1ed2a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Deliver Bill","icon":"","type":"basic","slug":"python-sdk-deliver-bill","order":40,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"deliver-bill","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-22T16:02:37.872Z","isBodyEmpty":false,"children":[]},{"_id":"6585b4171839960050fc9cf2","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Get Exchange Rates","icon":"","type":"basic","slug":"python-sdk-get-exchange-rates","order":41,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-exchange-rates","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-22T16:06:47.832Z","isBodyEmpty":false,"children":[]},{"_id":"6585b43bbb900600109235de","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Get Currencies","icon":"","type":"basic","slug":"python-sdk-get-currencies","order":42,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-currencies","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2023-12-22T16:07:23.124Z","isBodyEmpty":false,"children":[]},{"_id":"65f63fa8baca7d00241a4d44","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Retrieve Supported Wallets","icon":"","type":"basic","slug":"retrieve-supported-wallets-copy","order":43,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"65777224b173a300488689bf","category":"63b72b6e460c60008573ad9a","createdAt":"2024-03-17T00:56:08.459Z","isBodyEmpty":false,"children":[]}]},{"_id":"636d11d3f41a34006b4d1e22","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"C# Lite SDK (Retired)","icon":"","type":"basic","slug":"c-lite-sdk-getting-started-1","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"c-lite-sdk-getting-started","createdAt":"2022-11-10T14:59:31.141Z","category":"63b72b6e460c60008573ad9a","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"636d12dd65225e00986dcffb","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Create an Invoice","icon":"","type":"basic","slug":"c-lite-sdk-create-an-invoice","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-an-invoice","createdAt":"2022-11-10T15:03:57.129Z","parentDoc":"636d11d3f41a34006b4d1e22","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636d137dc5f7c70480e03d08","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Retrieve an Invoice","icon":"","type":"basic","slug":"c-lite-sdk-retrieve-an-invoice","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-an-invoice","createdAt":"2022-11-10T15:06:37.169Z","parentDoc":"636d11d3f41a34006b4d1e22","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636d141088247b105cac805b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get Exchange Rates","icon":"","type":"basic","slug":"c-lite-sdk-get-exchange-rates","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-exchange-rates","createdAt":"2022-11-10T15:09:04.904Z","parentDoc":"636d11d3f41a34006b4d1e22","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636d14676c31a100828a1ec2","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Create a Bill","icon":"","type":"basic","slug":"c-lite-sdk-create-a-bill","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-a-bill","createdAt":"2022-11-10T15:10:31.587Z","parentDoc":"636d11d3f41a34006b4d1e22","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636d14af24e0800d98b65f3c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Retrieve a Bill","icon":"","type":"basic","slug":"c-lite-retrieve-a-bill","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-a-bill","createdAt":"2022-11-10T15:11:43.263Z","parentDoc":"636d11d3f41a34006b4d1e22","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636d14f0cd2e8e119d661144","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Deliver a Bill","icon":"","type":"basic","slug":"c-lite-sdk-deliver-a-bill","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"deliver-a-bill","createdAt":"2022-11-10T15:12:48.629Z","parentDoc":"636d11d3f41a34006b4d1e22","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]}]},{"_id":"63776fdad1fe140020220c15","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Java Lite SDK (Retired)","icon":"","type":"basic","slug":"java-lite-sdk-getting-started","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"getting-started-1","createdAt":"2022-11-18T11:43:22.365Z","category":"63b72b6e460c60008573ad9a","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"6377724162a5b60063c796a8","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Create an Invoice","icon":"","type":"basic","slug":"java-lite-sdk-create-an-invoice","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-an-invoice-1","createdAt":"2022-11-18T11:53:37.615Z","parentDoc":"63776fdad1fe140020220c15","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"6377728063bdaf0031c7a79c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Retrieve an Invoice","icon":"","type":"basic","slug":"java-lite-sdk-retrieve-an-invoice","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-an-invoice-1","createdAt":"2022-11-18T11:54:40.607Z","parentDoc":"63776fdad1fe140020220c15","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"637772d2a2370e00a1bea6ef","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Create a Bill","icon":"","type":"basic","slug":"java-lite-sdk-create-a-bill","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-a-bill","createdAt":"2022-11-18T11:56:02.424Z","parentDoc":"63776fdad1fe140020220c15","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"637772fbf53ee7004f6005cd","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Retrieve a Bill","icon":"","type":"basic","slug":"java-lite-sdk-retrieve-a-bill","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-a-bill","createdAt":"2022-11-18T11:56:43.923Z","parentDoc":"63776fdad1fe140020220c15","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63777328bdbb140310a7bdba","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Deliver a Bill","icon":"","type":"basic","slug":"java-lite-sdk-deliver-a-bill","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"deliver-a-bill","createdAt":"2022-11-18T11:57:28.249Z","parentDoc":"63776fdad1fe140020220c15","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"637774338a0f6601e120de70","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get Exchange Rates","icon":"","type":"basic","slug":"java-lite-sdk-get-exchange-rates","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-exchange-rates","createdAt":"2022-11-18T12:01:55.156Z","parentDoc":"63776fdad1fe140020220c15","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"637773b451c2a4001d6c8233","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Errors","icon":"","type":"basic","slug":"java-lite-sdk-errors","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"errors","createdAt":"2022-11-18T11:59:48.816Z","category":"63b72b6e460c60008573ad9a","parentDoc":"63776fdad1fe140020220c15","isBodyEmpty":false,"children":[]}]},{"_id":"63650f57ec264f0062f4b5af","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"PHP Lite SDK (Retired)","icon":"","type":"basic","slug":"php-lite-sdk-getting-started","order":9,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"getting-started-1","createdAt":"2022-11-04T13:10:47.105Z","category":"63b72b6e460c60008573ad9a","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"63652a91618c770041e16a2d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Create an Invoice","icon":"","type":"basic","slug":"php-lite-sdk-create-an-invoice","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-an-invoice-1","createdAt":"2022-11-04T15:06:57.298Z","parentDoc":"63650f57ec264f0062f4b5af","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63652e34ecfa450010b20887","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Retrieve an Invoice","icon":"","type":"basic","slug":"php-lite-sdk-retrieve-an-invoice","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-an-invoice","createdAt":"2022-11-04T15:22:28.498Z","parentDoc":"63650f57ec264f0062f4b5af","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63652f0d7b7572004207457a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Create a Bill","icon":"","type":"basic","slug":"php-lite-sdk-create-a-bill","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-a-bill","createdAt":"2022-11-04T15:26:05.774Z","parentDoc":"63650f57ec264f0062f4b5af","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63652f3e835788001e957080","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get a Bill By ID","icon":"","type":"basic","slug":"php-lite-sdk-get-a-bill","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-a-bill","createdAt":"2022-11-04T15:26:54.643Z","parentDoc":"63650f57ec264f0062f4b5af","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"63653007be6b9f0076b147a4","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Deliver a Bill","icon":"","type":"basic","slug":"php-lite-sdk-deliver-a-bill","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"deliver-a-bill","createdAt":"2022-11-04T15:30:15.435Z","parentDoc":"63650f57ec264f0062f4b5af","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636535291147640053873994","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get Exchange Rates","icon":"","type":"basic","slug":"php-lite-sdk-get-exchange-rates","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-exchange-rates-1","createdAt":"2022-11-04T15:52:09.640Z","parentDoc":"63650f57ec264f0062f4b5af","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]},{"_id":"636535c1977adb04824a8549","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Get Currencies","icon":"","type":"basic","slug":"php-lite-sdk-get-currencies","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-currencies","createdAt":"2022-11-04T15:54:41.422Z","parentDoc":"63650f57ec264f0062f4b5af","category":"63b72b6e460c60008573ad9a","isBodyEmpty":false,"children":[]}]}]},{"_id":"6429f8193c0db4004eb3568a","title":"Demo Apps","slug":"demo-apps","order":9999,"reference":true,"project":"6356ce887031fa001e26e989","version":"6356ce887031fa001e26e98e","createdAt":"2023-04-02T21:48:09.946Z","__v":0,"pages":[{"_id":"6429f823295490002f280635","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"General Overview","icon":"","type":"basic","slug":"general-overview","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"6429f8193c0db4004eb3568a","createdAt":"2023-04-02T21:48:19.402Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"6429f84022651f0029ecbf90","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Java (Spring Boot) Kiosk Demo","icon":"","type":"basic","slug":"java-spring-boot-kiosk-demo","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"6429f8193c0db4004eb3568a","createdAt":"2023-04-02T21:48:48.244Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"6429f83622651f0029ecbf8b","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"PHP (Laravel) Kiosk Demo","icon":"","type":"basic","slug":"php-laravel-kiosk-demo","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"6429f8193c0db4004eb3568a","createdAt":"2023-04-02T21:48:38.651Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"6429f84ebac4af0011b891fe","api":{"method":"get","url":"","auth":"required","params":[]},"title":"C# (.NET) Kiosk Demo","icon":"","type":"basic","slug":"c-net-kiosk-demo","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"6429f8193c0db4004eb3568a","createdAt":"2023-04-02T21:49:02.547Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"66bf840f894974000ff7bea4","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"PHP (Symfony) Kiosk Demo","icon":"","type":"basic","slug":"php-symfony-kiosk-demo","order":999,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"6429f8193c0db4004eb3568a","createdAt":"2024-08-16T16:53:35.172Z","isBodyEmpty":false,"children":[]}]}]},"baseUrl":"/","apiBaseUrl":"/","search":{"appId":"T28YKFATPY","searchApiKey":"OTdiMTFlYjU1Y2UwYzE5YmVkZGMwNWViYzllYWJlZmY5NTJhYWU0MWE5NzRiNGIzMmM2NjQ1YTU1MDFiOTBkNnRhZ0ZpbHRlcnM9KHByb2plY3Q6NjM1NmNlODg3MDMxZmEwMDFlMjZlOTg5KSwodmVyc2lvbjpub25lLHZlcnNpb246NjM1NmNlODg3MDMxZmEwMDFlMjZlOThlKSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlLGluZGV4OkJsb2cp","indexName":"readme_search_v2","projectsMeta":[{"modules":{"landing":false,"docs":true,"examples":true,"reference":true,"graphql":false,"changelog":true,"discuss":false,"suggested_edits":true,"logs":false,"custompages":false,"tutorials":false},"id":"6356ce887031fa001e26e989","name":"bitpay","subdomain":"bitpay","subpath":"","nav_names":{"docs":"","reference":"API & SDK Documentation","changelog":"","discuss":"","tutorials":"","recipes":""}}],"UrlManager":{"options":{"child":false,"parent":null,"hasOneChild":false,"project":null,"version":null,"lang":"en"},"defaults":{"lang":"en"}},"urlManagerOpts":{"lang":"en","parent":{"childrenProjects":[]},"project":{"subdomain":"bitpay"},"version":"1.0"}},"activeDoc":"getting-started","rdmd":{"baseUrl":"/","body":"BitPay’s integrations make accepting blockchain payments fast and reliable. To get started, [sign up for a BitPay account](https://bitpay.com/dashboard/signup).\n\n## Accepting a Blockchain Payment\n\nWith blockchain payments, there's no sensitive customer information to collect and store, and there are no cards to charge. Customers simply send cryptocurrencies (like Bitcoin, Ether, or Ripple) from their computer or mobile device directly to a payment address.\n\nOnce received, BitPay converts the cryptocurrencies to your preferred currency and adds the full amount of the payment to your next BitPay account [settlement](/docs/settlement). Funds are then deposited to your bank account or cryptocurrency wallet.\n\nYou can accept blockchain payments in a variety of ways. Choose a method below to get started.\n\n## Online Payments\n\nBlockchain payments make the online payment experience simple and convenient for customers on any device – customers can pay with just two taps, no sensitive personal information needed.\n\n### E-Commerce Plugins\n\nAccepting cryptocurrency payments with our partner platforms can be as easy as flipping a switch. View our [full list of integrations](/docs/plugins) for details.\n\n### Code Libraries\n\nBitPay [code libraries](/docs/libraries) allow developers to focus on payment flow & e-commerce integration rather than on the specific details of client-server interaction using the API.\n\n### Direct API Implementation\n\nBuild yourself the integration using BitPay's [REST API](https://developer.bitpay.com/reference/concepts) to add blockchain payments to your online checkout.\n\n### Website Payment Buttons\n\nIf you are only selling a few items and do not have a checkout cart, simply generate a [payment button](/docs/ecommerce#buttons) for your website directly through your merchant dashboard. No code-wrangling required – just copy and embed the generated html code into your page.\n\n## In-Store Payments\n\nMerchants can use BitPay's retail payment tools alongside traditional point of sale systems to create a faster, hassle-free checkout experience for customers and staff.\n\n### BitPay Checkout App\n\nMerchants can use BitPay Checkout app to accept cryptocurrency payments on [iOS](https://itunes.apple.com/us/app/bitcoin-checkout/id929652207?mt=8) or [Android](https://play.google.com/store/apps/details?id=com.bitpay.checkout&hl=en) smartphones or tablets.\n\n## Donations\n\nNonprofits can get a running start with blockchain contributions with our donation buttons and hosted donation pages.\n\n### Donation Buttons\n\nBitPay's [donation buttons](/docs/donations#buttons) make it simple to accept contributions on your organization's website.\n\n### Hosted Donation Pages\n\nBitPay can create and host a customizable [donation webpage](/docs/donations#pages) for your organization.\n\n### Custom Web Page\n\nUse our [sample code](https://github.com/bitpay/bitpay-donation-sample-code) as a starting point to quickly set up a web page that is customized to your needs. \n\n## Billing\n\nOur blockchain billing tools allow merchants to invoice and receive payment for services and goods in no time flat.\n\n### Email Billing\n\nYou can use our [dashboard billing tool](https://bitpay.com/dashboard/payment-tools/bills) to create and email invoices to your clients in a snap. Bills can be scheduled for one-time or recurring payments.\n\n### Cross-Border Billing\n\nSkip costly, complicated cross-border wire transfers. Receive international accounts receivable payments and get 100% accuracy, zero fraud risk, and fast bank settlement.","opts":{"alwaysThrow":false,"compatibilityMode":false,"copyButtons":true,"correctnewlines":false,"markdownOptions":{"fences":true,"commonmark":true,"gfm":true,"ruleSpaces":false,"listItemIndent":"1","spacedTable":true,"paddedTable":true},"normalize":true,"lazyImages":true,"reusableContent":{"tags":{},"wrap":false},"safeMode":false,"settings":{"position":true},"theme":"light","resourceID":"6356ce887031fa001e26e994","resourceType":"page","baseUrl":"/","terms":[{"_id":"6356ce887031fa001e26e98a","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"variables":{"user":{},"defaults":[]}},"terms":[{"_id":"6356ce887031fa001e26e98a","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"variables":{"user":{},"defaults":[]},"mdx":false,"dehydrated":{"toc":"<nav><ul class=\"toc-list\"><li><a class=\"tocHeader\" href=\"#\"><i class=\"icon icon-text-align-left\"></i>Table of Contents</a></li><li class=\"toc-children\"><ul>\n<li>\n<a href=\"#accepting-a-blockchain-payment\">Accepting a Blockchain Payment</a>\n</li>\n<li>\n<a href=\"#online-payments\">Online Payments</a>\n<ul>\n<li><a href=\"#e-commerce-plugins\">E-Commerce Plugins</a></li>\n<li><a href=\"#code-libraries\">Code Libraries</a></li>\n<li><a href=\"#direct-api-implementation\">Direct API Implementation</a></li>\n<li><a href=\"#website-payment-buttons\">Website Payment Buttons</a></li>\n</ul>\n</li>\n<li>\n<a href=\"#in-store-payments\">In-Store Payments</a>\n<ul>\n<li><a href=\"#bitpay-checkout-app\">BitPay Checkout App</a></li>\n</ul>\n</li>\n<li>\n<a href=\"#donations\">Donations</a>\n<ul>\n<li><a href=\"#donation-buttons\">Donation Buttons</a></li>\n<li><a href=\"#hosted-donation-pages\">Hosted Donation Pages</a></li>\n<li><a href=\"#custom-web-page\">Custom Web Page</a></li>\n</ul>\n</li>\n<li>\n<a href=\"#billing\">Billing</a>\n<ul>\n<li><a href=\"#email-billing\">Email Billing</a></li>\n<li><a href=\"#cross-border-billing\">Cross-Border Billing</a></li>\n</ul>\n</li>\n</ul></li></ul></nav>","body":"<p>BitPay’s integrations make accepting blockchain payments fast and reliable. To get started, <a href=\"https://bitpay.com/dashboard/signup\" target=\"\" title=\"\">sign up for a BitPay account</a>.</p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"accepting-a-blockchain-payment\"></div><div class=\"heading-text\"><div id=\"section-accepting-a-blockchain-payment\" class=\"heading-anchor_backwardsCompatibility\"></div>Accepting a Blockchain Payment</div><a aria-label=\"Skip link to Accepting a Blockchain Payment\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#accepting-a-blockchain-payment\"></a></h2>\n<p>With blockchain payments, there&#x27;s no sensitive customer information to collect and store, and there are no cards to charge. Customers simply send cryptocurrencies (like Bitcoin, Ether, or Ripple) from their computer or mobile device directly to a payment address.</p>\n<p>Once received, BitPay converts the cryptocurrencies to your preferred currency and adds the full amount of the payment to your next BitPay account <a href=\"/docs/settlement\" target=\"\" title=\"\">settlement</a>. Funds are then deposited to your bank account or cryptocurrency wallet.</p>\n<p>You can accept blockchain payments in a variety of ways. Choose a method below to get started.</p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"online-payments\"></div><div class=\"heading-text\"><div id=\"section-online-payments\" class=\"heading-anchor_backwardsCompatibility\"></div>Online Payments</div><a aria-label=\"Skip link to Online Payments\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#online-payments\"></a></h2>\n<p>Blockchain payments make the online payment experience simple and convenient for customers on any device – customers can pay with just two taps, no sensitive personal information needed.</p>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"e-commerce-plugins\"></div><div class=\"heading-text\"><div id=\"section-e-commerce-plugins\" class=\"heading-anchor_backwardsCompatibility\"></div>E-Commerce Plugins</div><a aria-label=\"Skip link to E-Commerce Plugins\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#e-commerce-plugins\"></a></h3>\n<p>Accepting cryptocurrency payments with our partner platforms can be as easy as flipping a switch. View our <a href=\"/docs/plugins\" target=\"\" title=\"\">full list of integrations</a> for details.</p>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"code-libraries\"></div><div class=\"heading-text\"><div id=\"section-code-libraries\" class=\"heading-anchor_backwardsCompatibility\"></div>Code Libraries</div><a aria-label=\"Skip link to Code Libraries\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#code-libraries\"></a></h3>\n<p>BitPay <a href=\"/docs/libraries\" target=\"\" title=\"\">code libraries</a> allow developers to focus on payment flow &amp; e-commerce integration rather than on the specific details of client-server interaction using the API.</p>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"direct-api-implementation\"></div><div class=\"heading-text\"><div id=\"section-direct-api-implementation\" class=\"heading-anchor_backwardsCompatibility\"></div>Direct API Implementation</div><a aria-label=\"Skip link to Direct API Implementation\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#direct-api-implementation\"></a></h3>\n<p>Build yourself the integration using BitPay&#x27;s <a href=\"https://developer.bitpay.com/reference/concepts\" target=\"\" title=\"\">REST API</a> to add blockchain payments to your online checkout.</p>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"website-payment-buttons\"></div><div class=\"heading-text\"><div id=\"section-website-payment-buttons\" class=\"heading-anchor_backwardsCompatibility\"></div>Website Payment Buttons</div><a aria-label=\"Skip link to Website Payment Buttons\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#website-payment-buttons\"></a></h3>\n<p>If you are only selling a few items and do not have a checkout cart, simply generate a <a href=\"/docs/ecommerce#buttons\" target=\"\" title=\"\">payment button</a> for your website directly through your merchant dashboard. No code-wrangling required – just copy and embed the generated html code into your page.</p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"in-store-payments\"></div><div class=\"heading-text\"><div id=\"section-in-store-payments\" class=\"heading-anchor_backwardsCompatibility\"></div>In-Store Payments</div><a aria-label=\"Skip link to In-Store Payments\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#in-store-payments\"></a></h2>\n<p>Merchants can use BitPay&#x27;s retail payment tools alongside traditional point of sale systems to create a faster, hassle-free checkout experience for customers and staff.</p>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"bitpay-checkout-app\"></div><div class=\"heading-text\"><div id=\"section-bit-pay-checkout-app\" class=\"heading-anchor_backwardsCompatibility\"></div>BitPay Checkout App</div><a aria-label=\"Skip link to BitPay Checkout App\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#bitpay-checkout-app\"></a></h3>\n<p>Merchants can use BitPay Checkout app to accept cryptocurrency payments on <a href=\"https://itunes.apple.com/us/app/bitcoin-checkout/id929652207?mt=8\" target=\"\" title=\"\">iOS</a> or <a href=\"https://play.google.com/store/apps/details?id=com.bitpay.checkout&amp;hl=en\" target=\"\" title=\"\">Android</a> smartphones or tablets.</p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"donations\"></div><div class=\"heading-text\"><div id=\"section-donations\" class=\"heading-anchor_backwardsCompatibility\"></div>Donations</div><a aria-label=\"Skip link to Donations\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#donations\"></a></h2>\n<p>Nonprofits can get a running start with blockchain contributions with our donation buttons and hosted donation pages.</p>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"donation-buttons\"></div><div class=\"heading-text\"><div id=\"section-donation-buttons\" class=\"heading-anchor_backwardsCompatibility\"></div>Donation Buttons</div><a aria-label=\"Skip link to Donation Buttons\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#donation-buttons\"></a></h3>\n<p>BitPay&#x27;s <a href=\"/docs/donations#buttons\" target=\"\" title=\"\">donation buttons</a> make it simple to accept contributions on your organization&#x27;s website.</p>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"hosted-donation-pages\"></div><div class=\"heading-text\"><div id=\"section-hosted-donation-pages\" class=\"heading-anchor_backwardsCompatibility\"></div>Hosted Donation Pages</div><a aria-label=\"Skip link to Hosted Donation Pages\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#hosted-donation-pages\"></a></h3>\n<p>BitPay can create and host a customizable <a href=\"/docs/donations#pages\" target=\"\" title=\"\">donation webpage</a> for your organization.</p>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"custom-web-page\"></div><div class=\"heading-text\"><div id=\"section-custom-web-page\" class=\"heading-anchor_backwardsCompatibility\"></div>Custom Web Page</div><a aria-label=\"Skip link to Custom Web Page\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#custom-web-page\"></a></h3>\n<p>Use our <a href=\"https://github.com/bitpay/bitpay-donation-sample-code\" target=\"\" title=\"\">sample code</a> as a starting point to quickly set up a web page that is customized to your needs. </p>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"billing\"></div><div class=\"heading-text\"><div id=\"section-billing\" class=\"heading-anchor_backwardsCompatibility\"></div>Billing</div><a aria-label=\"Skip link to Billing\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#billing\"></a></h2>\n<p>Our blockchain billing tools allow merchants to invoice and receive payment for services and goods in no time flat.</p>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"email-billing\"></div><div class=\"heading-text\"><div id=\"section-email-billing\" class=\"heading-anchor_backwardsCompatibility\"></div>Email Billing</div><a aria-label=\"Skip link to Email Billing\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#email-billing\"></a></h3>\n<p>You can use our <a href=\"https://bitpay.com/dashboard/payment-tools/bills\" target=\"\" title=\"\">dashboard billing tool</a> to create and email invoices to your clients in a snap. Bills can be scheduled for one-time or recurring payments.</p>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"cross-border-billing\"></div><div class=\"heading-text\"><div id=\"section-cross-border-billing\" class=\"heading-anchor_backwardsCompatibility\"></div>Cross-Border Billing</div><a aria-label=\"Skip link to Cross-Border Billing\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#cross-border-billing\"></a></h3>\n<p>Skip costly, complicated cross-border wire transfers. Receive international accounts receivable payments and get 100% accuracy, zero fraud risk, and fast bank settlement.</p>"}},"doc":{"metadata":{"image":[],"title":"","description":"","keywords":"","robots":"index"},"mdx":{"altBody":"","status":"rdmd"},"api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"examples":{"codes":[]}},"next":{"description":"","pages":[]},"algolia":{"recordCount":16,"publishPending":false,"translationFailure":false,"updatedAt":"2024-10-31T15:29:31.898Z"},"title":"Getting Started with BitPay","icon":"","updates":["63864772932c3a0033fbdaf1","64e6696c733f4400385d37ed","65cd1cdcc59c37001d854d1d"],"type":"basic","slug":"getting-started","excerpt":"This page will help you get started with BitPay. You'll be up and running in a jiffy!","body":"BitPay’s integrations make accepting blockchain payments fast and reliable. To get started, [sign up for a BitPay account](https://bitpay.com/dashboard/signup).\n\n## Accepting a Blockchain Payment\n\nWith blockchain payments, there's no sensitive customer information to collect and store, and there are no cards to charge. Customers simply send cryptocurrencies (like Bitcoin, Ether, or Ripple) from their computer or mobile device directly to a payment address.\n\nOnce received, BitPay converts the cryptocurrencies to your preferred currency and adds the full amount of the payment to your next BitPay account [settlement](/docs/settlement). Funds are then deposited to your bank account or cryptocurrency wallet.\n\nYou can accept blockchain payments in a variety of ways. Choose a method below to get started.\n\n## Online Payments\n\nBlockchain payments make the online payment experience simple and convenient for customers on any device – customers can pay with just two taps, no sensitive personal information needed.\n\n### E-Commerce Plugins\n\nAccepting cryptocurrency payments with our partner platforms can be as easy as flipping a switch. View our [full list of integrations](/docs/plugins) for details.\n\n### Code Libraries\n\nBitPay [code libraries](/docs/libraries) allow developers to focus on payment flow & e-commerce integration rather than on the specific details of client-server interaction using the API.\n\n### Direct API Implementation\n\nBuild yourself the integration using BitPay's [REST API](https://developer.bitpay.com/reference/concepts) to add blockchain payments to your online checkout.\n\n### Website Payment Buttons\n\nIf you are only selling a few items and do not have a checkout cart, simply generate a [payment button](/docs/ecommerce#buttons) for your website directly through your merchant dashboard. No code-wrangling required – just copy and embed the generated html code into your page.\n\n## In-Store Payments\n\nMerchants can use BitPay's retail payment tools alongside traditional point of sale systems to create a faster, hassle-free checkout experience for customers and staff.\n\n### BitPay Checkout App\n\nMerchants can use BitPay Checkout app to accept cryptocurrency payments on [iOS](https://itunes.apple.com/us/app/bitcoin-checkout/id929652207?mt=8) or [Android](https://play.google.com/store/apps/details?id=com.bitpay.checkout&hl=en) smartphones or tablets.\n\n## Donations\n\nNonprofits can get a running start with blockchain contributions with our donation buttons and hosted donation pages.\n\n### Donation Buttons\n\nBitPay's [donation buttons](/docs/donations#buttons) make it simple to accept contributions on your organization's website.\n\n### Hosted Donation Pages\n\nBitPay can create and host a customizable [donation webpage](/docs/donations#pages) for your organization.\n\n### Custom Web Page\n\nUse our [sample code](https://github.com/bitpay/bitpay-donation-sample-code) as a starting point to quickly set up a web page that is customized to your needs. \n\n## Billing\n\nOur blockchain billing tools allow merchants to invoice and receive payment for services and goods in no time flat.\n\n### Email Billing\n\nYou can use our [dashboard billing tool](https://bitpay.com/dashboard/payment-tools/bills) to create and email invoices to your clients in a snap. Bills can be scheduled for one-time or recurring payments.\n\n### Cross-Border Billing\n\nSkip costly, complicated cross-border wire transfers. Receive international accounts receivable payments and get 100% accuracy, zero fraud risk, and fast bank settlement.","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"reusableContent":[],"previousSlug":"","slugUpdatedAt":"2022-10-23T18:30:56.130Z","revision":21,"_id":"6356ce887031fa001e26e994","pendingAlgoliaPublish":false,"user":"63580c98096a7800a0519c4a","project":"6356ce887031fa001e26e989","category":{"title":"Documentation","slug":"documentation","order":0,"reference":false,"_id":"6356ce887031fa001e26e991","version":"6356ce887031fa001e26e98e","project":"6356ce887031fa001e26e989","createdAt":"2022-10-24T17:42:32.716Z","__v":0,"type":"guide","id":"6356ce887031fa001e26e991"},"createdAt":"2022-10-24T17:42:32.762Z","updatedAt":"2024-10-31T15:29:31.905Z","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6356ce887031fa001e26e991","6356ce887031fa001e26e991","63595c46f0170204f0097ec2","636162cd170029008205672d","636162d11860cf008608eae6","636162d5b9fd1300418b7cbb","636162d8470cb2001fc2848d","63618882de4302003d7b1e0d","63618887a0cd0d0038b36ec9","6361888f7225b900a45e1c3c","636bb5462dc0f80016bb7c74","636c2e44f41a34006b3b0db2","636c2ea994670f0016cc780b","636c2fc543757a0082e0ea5e","636d114c37357d0031019c88","63723ba034ecbf0091ba76d1","6376b4ac2ac94400030a93a4","63865a8828e30e008a1a96f8","638a375dc450c300a7320c98","639c9a14e9e67d003592770c","63b72b6e460c60008573ad9a","6429f8193c0db4004eb3568a"],"pdfStatus":"","_id":"6356ce887031fa001e26e98e","project":"6356ce887031fa001e26e989","releaseDate":"2022-10-24T17:42:32.678Z","createdAt":"2022-10-24T17:42:32.678Z","__v":1},"__v":3,"parentDoc":null,"lastUpdatedHash":"f122950cfefff34d7dc2d730fe961fc6f7107c22","isApi":false,"tutorials":[],"id":"6356ce887031fa001e26e994"},"hideTOC":false,"meta":{"_id":"6356ce887031fa001e26e994","description":"This page will help you get started with BitPay. You'll be up and running in a jiffy!","hidden":false,"image":[],"keywords":"","metaTitle":"Getting Started with BitPay","parent":null,"robots":"index","slug":"getting-started","title":"Getting Started with BitPay","type":"docs"},"slugUrl":"/docs/getting-started","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-2024-05","fullstory":{"enabled":true,"orgId":"FSV9A"},"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.235.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":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":"6356ce887031fa001e26e98a","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"variables":{"user":{},"defaults":[]},"project":{"_id":"6356ce887031fa001e26e989","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":"#1a3a8b","main_alt":"","header_text":"","body_highlight":"","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":"solid","img":[],"img_size":"auto","img_pos":"tl"},"body":{"style":"none"},"global_landing_page":{"html":"","redirect":""},"referenceSimpleMode":true,"referenceLayout":"row","link_logo_to_url":false,"theme":"solid","colorScheme":"system","overlay":"triangles","landing":true,"sticky":false,"hide_logo":false,"childrenAsPills":false,"subheaderStyle":"links","splitReferenceDocs":false,"showMetricsInReference":false,"logo":["https://files.readme.io/45785f4-brandmark-blue.svg","readme.svg",60,60,"#048ef5"],"loginLogo":[],"logo_white":["https://files.readme.io/de78cc6-small-bitpay-logo.png","bitpay-logo.png",229,80,"#ffffff","https://files.readme.io/5f6b2ca-bitpay-logo.png"],"logo_white_use":true,"logo_large":false,"favicon":["https://files.readme.io/5aeef98-favicon.ico","favicon.ico",256,256,"#000000"],"stylesheet":"","stylesheet_hub2":".table .child::before {\n content: '\\21B3';\n margin-right: 12px;\n}\n\n.table .childchild::before {\n content: '\\21B3';\n margin-right: 12px;\n padding-left: 24px;\n}\n\n.table .childchildchild::before {\n content: '\\21B3';\n margin-right: 12px;\n padding-left: 36px;\n}","stylesheet_hub3":"","javascript":"","javascript_hub2":"","html_promo":"","html_body":"","html_footer":"","html_head":"<script>\nfunction showhide(control) {\n var target = `[aria-controls=\"${control}-collapse\"] img`;\n var icon = document.querySelector(target);\n var x = document.getElementById(`${control}-collapse`);\n if (x.style.display === \"none\") {\n x.style.display = \"block\";\n icon.src = \"data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgd2lkdGg9IjI0IiBoZWlnaHQ9IjI0Ij48dGl0bGU+RGVsZXRlPC90aXRsZT48ZyBjbGFzcz0ibmMtaWNvbi13cmFwcGVyIiBmaWxsPSIjZmZmZmZmIj48cmVjdCB4PSI2IiB5PSIxMSIgd2lkdGg9IjEyIiBoZWlnaHQ9IjIiIGZpbGw9IiNmZmZmZmYiLz48L2c+PC9zdmc+Cg==\";\n } else {\n x.style.display = \"none\";\n icon.src = \"data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgd2lkdGg9IjI0IiBoZWlnaHQ9IjI0Ij48dGl0bGU+QWRkPC90aXRsZT48ZyBjbGFzcz0ibmMtaWNvbi13cmFwcGVyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIHN0cm9rZS13aWR0aD0iMiIgZmlsbD0iI2ZmZmZmZiIgc3Ryb2tlPSIjZmZmZmZmIj48bGluZSBmaWxsPSJub25lIiBzdHJva2U9IiNmZmZmZmYiIHN0cm9rZS1taXRlcmxpbWl0PSIxMCIgeDE9IjEyIiB5MT0iNyIgeDI9IjEyIiB5Mj0iMTciLz4gPGxpbmUgZmlsbD0ibm9uZSIgc3Ryb2tlPSIjZmZmZmZmIiBzdHJva2UtbWl0ZXJsaW1pdD0iMTAiIHgxPSIxNyIgeTE9IjEyIiB4Mj0iNyIgeTI9IjEyIi8+PC9nPjwvc3ZnPgo=\";\n }\n}\n</script>","html_footer_meta":"","html_hidelinks":false,"showVersion":false,"hideTableOfContents":false,"nextStepsLabel":"","promos":[{"extras":{"type":"search","buttonPrimary":"docs","buttonSecondary":"reference"},"title":"BitPay Developer Hub","text":"","_id":"6356ce887031fa001e26e98b"}],"changelog":{"layoutExpanded":false,"showAuthor":true,"showExactDate":false},"allowApiExplorerJsonEditor":false},"custom_domain":"developer.bitpay.com","childrenProjects":[],"derivedPlan":"business2018","description":"","error404":"","experiments":[],"first_page":"landing","flags":{"allowApiExplorerJsonEditor":false,"allowDarkMode":false,"alwaysShowDocPublishStatus":false,"allowXFrame":false,"correctnewlines":false,"dashReact":false,"disablePasswordlessLogin":false,"directGoogleToStableVersion":false,"disableAnonForum":false,"enterprise":false,"graphql":false,"migrationRun":false,"migrationSwaggerRun":false,"newEditor":true,"newEditorDash":true,"newMarkdownBetaProgram":true,"newSearch":true,"oauth":false,"oldMarkdown":false,"rdmdCompatibilityMode":false,"reviewWorkflow":true,"singleProjectEnterprise":false,"speedyRender":false,"staging":false,"star":false,"swagger":false,"translation":false,"useReactApp":true,"useReactGLP":false,"myDevelopers":false,"allowReusableOTPs":false,"developerDashboard":false,"superHub":false,"owlbotAi":false,"apiV2":false,"dashQuickstart":false,"git":{"read":false,"write":false},"superHubBeta":false,"disableAutoTranslate":false,"customBlocks":false,"devDashHub":false,"disableSAMLScoping":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"apiAccessRevoked":false,"passwordlessLogin":"default","disableSignups":false,"billingRedesignEnabled":true,"developerPortal":false,"mdx":false,"superHubDevelopment":false,"annualBillingEnabled":true,"devDashBillingRedesignEnabled":false,"enableOidc":false,"customComponents":false,"disableDiscussionSpamRecaptchaBypass":false,"developerViewUsersData":false,"changelogRssAlwaysPublic":false,"bidiSync":false,"superHubMigrationSelfServeFlow":false},"fullBaseUrl":"https://developer.bitpay.com/","git":{"migration":{"createRepository":{},"transformation":{},"migratingPages":{},"enableSuperhub":{}},"sync":{"connectedRepository":{"organization":{},"privacy":{}},"installationRequest":{},"github":[]}},"glossaryTerms":[{"_id":"6356ce887031fa001e26e98a","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"graphqlSchema":"","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"hasOneChild":false,"healthCheck":{"provider":"statusPage","settings":{"page":"xj85sy9rc4v9","status":false,"url":""}},"intercom_secure_emailonly":false,"intercom":"","is_active":true,"internal":"","jwtExpirationTime":0,"landing_bottom":[{"type":"docs","alignment":"left","pageType":"Documentation"}],"mdxMigrationStatus":"rdmd","metrics":{"realtime":{"dashEnabled":false,"hubEnabled":false},"monthlyLimit":0,"planLimit":5000000,"thumbsEnabled":true,"monthlyPurchaseLimit":0,"meteredBilling":{}},"modules":{"landing":false,"docs":true,"examples":true,"reference":true,"graphql":false,"changelog":true,"discuss":false,"suggested_edits":true,"logs":false,"custompages":false,"tutorials":false},"name":"bitpay","nav_names":{"docs":"","reference":"API & SDK Documentation","changelog":"","discuss":"","tutorials":"","recipes":""},"oauth_url":"","onboardingCompleted":{"documentation":true,"appearance":false,"jwt":false,"api":true,"logs":false,"domain":true,"metricsSDK":false},"owlbot":{"enabled":true,"isPaying":true,"lastIndexed":"2024-11-28T01:30:16.776Z","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":false,"points":35},"syncingOAS":{"enabled":false,"points":10},"customLogin":{"enabled":false,"points":25},"metrics":{"enabled":false,"points":40},"recipes":{"enabled":false,"points":15},"pageVoting":{"enabled":true,"points":1},"suggestedEdits":{"enabled":true,"points":10},"support":{"enabled":false,"points":5},"htmlLanding":{"enabled":false,"points":5},"guides":{"enabled":true,"points":10},"changelog":{"enabled":true,"points":5},"glossary":{"enabled":false,"points":1},"variables":{"enabled":false,"points":1},"integrations":{"enabled":true,"points":2}},"totalScore":103},"reCaptchaSiteKey":"","reference":{"alwaysUseDefaults":true,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":false,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":false},"stable":{"_id":"6356ce887031fa001e26e98e","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6356ce887031fa001e26e991","6356ce887031fa001e26e991","63595c46f0170204f0097ec2","636162cd170029008205672d","636162d11860cf008608eae6","636162d5b9fd1300418b7cbb","636162d8470cb2001fc2848d","63618882de4302003d7b1e0d","63618887a0cd0d0038b36ec9","6361888f7225b900a45e1c3c","636bb5462dc0f80016bb7c74","636c2e44f41a34006b3b0db2","636c2ea994670f0016cc780b","636c2fc543757a0082e0ea5e","636d114c37357d0031019c88","63723ba034ecbf0091ba76d1","6376b4ac2ac94400030a93a4","63865a8828e30e008a1a96f8","638a375dc450c300a7320c98","639c9a14e9e67d003592770c","63b72b6e460c60008573ad9a","6429f8193c0db4004eb3568a"],"project":"6356ce887031fa001e26e989","releaseDate":"2022-10-24T17:42:32.678Z","createdAt":"2022-10-24T17:42:32.678Z","__v":1},"subdomain":"bitpay","subpath":"","superHubWaitlist":false,"topnav":{"left":[],"right":[],"bottom":[],"edited":true},"trial":{"trialDeadlineEnabled":true,"trialEndsAt":"2022-11-07T17:42:32.353Z"},"translate":{"provider":"transifex","show_widget":false,"key_public":"","org_name":"","project_name":"","languages":[]},"url":"https://bitpay.com/","versions":[{"_id":"6356ce887031fa001e26e98e","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6356ce887031fa001e26e991","6356ce887031fa001e26e991","63595c46f0170204f0097ec2","636162cd170029008205672d","636162d11860cf008608eae6","636162d5b9fd1300418b7cbb","636162d8470cb2001fc2848d","63618882de4302003d7b1e0d","63618887a0cd0d0038b36ec9","6361888f7225b900a45e1c3c","636bb5462dc0f80016bb7c74","636c2e44f41a34006b3b0db2","636c2ea994670f0016cc780b","636c2fc543757a0082e0ea5e","636d114c37357d0031019c88","63723ba034ecbf0091ba76d1","6376b4ac2ac94400030a93a4","63865a8828e30e008a1a96f8","638a375dc450c300a7320c98","639c9a14e9e67d003592770c","63b72b6e460c60008573ad9a","6429f8193c0db4004eb3568a"],"project":"6356ce887031fa001e26e989","releaseDate":"2022-10-24T17:42:32.678Z","createdAt":"2022-10-24T17:42:32.678Z","__v":1}],"variableDefaults":[],"webhookEnabled":false,"isHubEditable":true},"projectStore":{"data":{"allow_crawlers":"disabled","glossary":[{"_id":"6356ce887031fa001e26e98a","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"canonical_url":null,"description":null,"parent":null,"homepage_url":"https://bitpay.com/","id":"6356ce887031fa001e26e989","is_migrated":false,"name":"bitpay","redirects":[],"sitemap":"disabled","subdomain":"bitpay","suggested_edits":"enabled","uri":"/projects/me","variable_defaults":[],"webhooks":[],"custom_login":{"login_url":null,"logout_url":null},"onboarding_completed":{"api":true,"appearance":false,"documentation":true,"domain":true,"jwt":false,"logs":false,"metricsSDK":false},"pages":{"not_found":null},"privacy":{"view":"public","password":null},"reference":{"api_sdk_snippets":"enabled","defaults":"always_use","json_editor":"disabled","oauth_flows":"disabled","request_history":"disabled","response_examples":"collapsed","response_schemas":"collapsed"},"seo":{"overwrite_title_tag":"disabled"},"plan":{"type":"business2018","grace_period":{"enabled":false,"end_date":null},"trial":{"expired":false,"end_date":"2022-11-07T17:42:32.353Z"}},"health_check":{"provider":"statuspage","settings":{"manual":{"status":"down","url":null},"statuspage":{"id":"xj85sy9rc4v9"}}},"integrations":{"bing":{"verify":null},"google":{"analytics":null,"site_verification":null},"heap":{"id":null},"koala":{"key":null},"localize":{"key":null},"recaptcha":{"site_key":null,"secret_key":null},"segment":{"key":null,"domain":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"}}},"appearance":{"brand":{"primary_color":"#1a3a8b","link_color":null,"theme":"system"},"changelog":{"layout":"collapsed","show_author":true,"show_exact_date":false},"markdown":{"callouts":{"icon_font":"emojis"}},"table_of_contents":"enabled","whats_next_label":null,"footer":{"readme_logo":"show"},"logo":{"size":"default","dark_mode":{"uri":null,"url":"https://files.readme.io/de78cc6-small-bitpay-logo.png","name":"bitpay-logo.png","width":229,"height":80,"color":"#ffffff","links":{"original_url":"https://files.readme.io/5f6b2ca-bitpay-logo.png"}},"main":{"uri":null,"url":"https://files.readme.io/45785f4-brandmark-blue.svg","name":"readme.svg","width":60,"height":60,"color":"#048ef5","links":{"original_url":null}},"favicon":{"uri":null,"url":"https://files.readme.io/5aeef98-favicon.ico","name":"favicon.ico","width":256,"height":256,"color":"#000000","links":{"original_url":null}}},"custom_code":{"css":".table .child::before {\n content: '\\21B3';\n margin-right: 12px;\n}\n\n.table .childchild::before {\n content: '\\21B3';\n margin-right: 12px;\n padding-left: 24px;\n}\n\n.table .childchildchild::before {\n content: '\\21B3';\n margin-right: 12px;\n padding-left: 36px;\n}","js":null,"html":{"header":"<script>\nfunction showhide(control) {\n var target = `[aria-controls=\"${control}-collapse\"] img`;\n var icon = document.querySelector(target);\n var x = document.getElementById(`${control}-collapse`);\n if (x.style.display === \"none\") {\n x.style.display = \"block\";\n icon.src = \"data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgd2lkdGg9IjI0IiBoZWlnaHQ9IjI0Ij48dGl0bGU+RGVsZXRlPC90aXRsZT48ZyBjbGFzcz0ibmMtaWNvbi13cmFwcGVyIiBmaWxsPSIjZmZmZmZmIj48cmVjdCB4PSI2IiB5PSIxMSIgd2lkdGg9IjEyIiBoZWlnaHQ9IjIiIGZpbGw9IiNmZmZmZmYiLz48L2c+PC9zdmc+Cg==\";\n } else {\n x.style.display = \"none\";\n icon.src = \"data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgd2lkdGg9IjI0IiBoZWlnaHQ9IjI0Ij48dGl0bGU+QWRkPC90aXRsZT48ZyBjbGFzcz0ibmMtaWNvbi13cmFwcGVyIiBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIHN0cm9rZS13aWR0aD0iMiIgZmlsbD0iI2ZmZmZmZiIgc3Ryb2tlPSIjZmZmZmZmIj48bGluZSBmaWxsPSJub25lIiBzdHJva2U9IiNmZmZmZmYiIHN0cm9rZS1taXRlcmxpbWl0PSIxMCIgeDE9IjEyIiB5MT0iNyIgeDI9IjEyIiB5Mj0iMTciLz4gPGxpbmUgZmlsbD0ibm9uZSIgc3Ryb2tlPSIjZmZmZmZmIiBzdHJva2UtbWl0ZXJsaW1pdD0iMTAiIHgxPSIxNyIgeTE9IjEyIiB4Mj0iNyIgeTI9IjEyIi8+PC9nPjwvc3ZnPgo=\";\n }\n}\n</script>","home_footer":null,"page_footer":null}},"header":{"type":"solid","gradient_color":null,"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}}}},"navigation":{"first_page":"landing_page","left":[],"logo_link":"landing_page","right":[],"sub_nav":[],"subheader_layout":"links","version":"disabled","links":{"home":{"label":"Home","visibility":"disabled"},"graphql":{"label":"GraphQL","visibility":"disabled"},"guides":{"label":"Guides","alias":null,"visibility":"enabled"},"reference":{"label":"API Reference","alias":"API & SDK Documentation","visibility":"enabled"},"recipes":{"label":"Recipes","alias":null,"visibility":"disabled"},"changelog":{"label":"Changelog","alias":null,"visibility":"enabled"},"discussions":{"label":"Discussions","alias":null,"visibility":"disabled"}}}}}},"version":{"_id":"6356ce887031fa001e26e98e","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6356ce887031fa001e26e991","6356ce887031fa001e26e991","63595c46f0170204f0097ec2","636162cd170029008205672d","636162d11860cf008608eae6","636162d5b9fd1300418b7cbb","636162d8470cb2001fc2848d","63618882de4302003d7b1e0d","63618887a0cd0d0038b36ec9","6361888f7225b900a45e1c3c","636bb5462dc0f80016bb7c74","636c2e44f41a34006b3b0db2","636c2ea994670f0016cc780b","636c2fc543757a0082e0ea5e","636d114c37357d0031019c88","63723ba034ecbf0091ba76d1","6376b4ac2ac94400030a93a4","63865a8828e30e008a1a96f8","638a375dc450c300a7320c98","639c9a14e9e67d003592770c","63b72b6e460c60008573ad9a","6429f8193c0db4004eb3568a"],"project":"6356ce887031fa001e26e989","releaseDate":"2022-10-24T17:42:32.678Z","createdAt":"2022-10-24T17:42:32.678Z","__v":1}},"reqUrl":"/docs/getting-started","version":{"_id":"6356ce887031fa001e26e98e","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6356ce887031fa001e26e991","6356ce887031fa001e26e991","63595c46f0170204f0097ec2","636162cd170029008205672d","636162d11860cf008608eae6","636162d5b9fd1300418b7cbb","636162d8470cb2001fc2848d","63618882de4302003d7b1e0d","63618887a0cd0d0038b36ec9","6361888f7225b900a45e1c3c","636bb5462dc0f80016bb7c74","636c2e44f41a34006b3b0db2","636c2ea994670f0016cc780b","636c2fc543757a0082e0ea5e","636d114c37357d0031019c88","63723ba034ecbf0091ba76d1","6376b4ac2ac94400030a93a4","63865a8828e30e008a1a96f8","638a375dc450c300a7320c98","639c9a14e9e67d003592770c","63b72b6e460c60008573ad9a","6429f8193c0db4004eb3568a"],"project":"6356ce887031fa001e26e989","releaseDate":"2022-10-24T17:42:32.678Z","createdAt":"2022-10-24T17:42:32.678Z","__v":1},"lang":"en","langFull":"Default","isDetachedProductionSite":false}"></script></div><div id="hub-container"><div class="hub-container"><div state-container ng-attr-id="{{state.current().root !== 'docs' && 'react-app-content-container'}}"><div id="replace-view" ng-non-bindable></div></div></div></div><script>var is_hub = true; var is_hub2 = true; var is_hub_edit = true; </script><div id="ssr-end"><script id="__LOADABLE_REQUIRED_CHUNKS__" type="application/json">[6859,1802,9772,3284,7449,7372,9082,572,5312,5548,2395,6522,7112,4608,8263,1282,2852,3880,7783,1456,4935,7971,6722,153,1313,5798,4002,3787,1666,6841,1936,6922,2859,1080,9852,8684,9575,8063,1343,6060,2144,9141,1202,678,3859,2637,4674,1731,5408,2616,3412,3221,7327,7285,3307,1948,2402,2578,4793,4467,7289,7031,3556,8899]</script><script id="__LOADABLE_REQUIRED_CHUNKS___ext" type="application/json">{"namedChunks":["routes-SuperHub","Header","core-icons-chevron-up-down-svg","routes-Reference","Footer","routes-Landing","routes-PageNotFound","routes-Doc","CustomPage","Editor","core-icons-x-circle-svg","core-icons-suggested-edits-svg","core-icons-arrow-right-svg","core-icons-arrow-up-right-svg","core-icons-more-vertical-svg","core-icons-lock-svg","routes-Changelog","Post","core-icons-alert-circle-svg","core-icons-webhook-svg","core-icons-chevron-down-svg","List","routes-Discuss","core-icons-trending-up-svg","core-icons-callout-info-svg","routes-CustomPage","core-icons-search-svg","core-icons-custom-pages-svg","routes-SuperHub-Routes","rmdx","Page","core-icons-eye-off-svg","core-icons-star-svg","routes-Tutorials","core-icons-inbox-svg","core-icons-message-circle-svg","core-icons-key-svg","core-graphics-json-svg","New"]}</script> <script async data-chunk="main" src="https://cdn.readme.io/public/hub/web/main.766cf20fa350c2c18107.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6859.fc1496da022e612abe33.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1802.00a1e88cc0d9da2aae1b.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9772.1912e092b9c8785ff5c3.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/3284.6ecd6ef27e2009d3fdc7.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7372.aa4569536a36087cf4a9.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9082.f9fa9ec2b80af1ef61bd.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/572.bab1eda8453360a8a761.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/5312.ca2c08ec1b75bb03c21e.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/5548.8fb1bb5d57de6c263c67.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/2395.6288c030d5183baa5a89.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6522.057d8ea587133ae98687.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7112.69c3d611e7e54e411b26.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/4608.3b5a227647e78e858c3f.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/8263.a563779273b90f66c0db.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1282.591f476c316bf3670bbd.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/routes-SuperHub.a3bb3020bf29f8f67ef8.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/3880.3892311d81c548cb073c.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/7783.48ca7ef3a5c469d97e53.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/Header.ad57d9fcd570c04fb712.js"></script> <script async data-chunk="core-icons-chevron-up-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/7971.db270c2970b791e38435.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/6722.e485c5aa155bd0f0ccf8.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/153.e4db5a313c7d51383015.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/routes-Reference.d66a49f09580aafdabb6.js"></script> <script async data-chunk="Footer" src="https://cdn.readme.io/public/hub/web/Footer.eb98b86c4279989f5a59.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/4002.08d1caef58d08eaccd19.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/routes-Landing.f0816876bdfbbc06801a.js"></script> <script async data-chunk="routes-PageNotFound" src="https://cdn.readme.io/public/hub/web/routes-PageNotFound.84a460336ee9c83a7d55.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/6841.587d285d41ca8bab11b1.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/routes-Doc.e3a4e0817a9a640436bc.js"></script> <script async data-chunk="CustomPage" src="https://cdn.readme.io/public/hub/web/6922.e8247ef6931a72e55b3e.js"></script> <script async data-chunk="CustomPage" src="https://cdn.readme.io/public/hub/web/2859.94b03b9a9585460aa921.js"></script> <script async data-chunk="Editor" src="https://cdn.readme.io/public/hub/web/Editor.002979730c36f9c65ad3.js"></script> <script async data-chunk="core-icons-x-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-x-circle-svg.abc0e0ea5b7f9dff667c.js"></script> <script async data-chunk="core-icons-suggested-edits-svg" src="https://cdn.readme.io/public/hub/web/core-icons-suggested-edits-svg.8d2d8ac2fd22ded9238d.js"></script> <script async data-chunk="core-icons-arrow-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-arrow-right-svg.eadb74658f93b4e7d75f.js"></script> <script async data-chunk="core-icons-arrow-up-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-arrow-up-right-svg.8ec73f7e322d79a2695b.js"></script> <script async data-chunk="core-icons-more-vertical-svg" src="https://cdn.readme.io/public/hub/web/core-icons-more-vertical-svg.4822b3f831e11095980d.js"></script> <script async data-chunk="core-icons-lock-svg" src="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"></script> <script async data-chunk="routes-Changelog" src="https://cdn.readme.io/public/hub/web/routes-Changelog.3f125a62ed05cc53aec4.js"></script> <script async data-chunk="Post" src="https://cdn.readme.io/public/hub/web/Post.cced33af5051de7f473f.js"></script> <script async data-chunk="core-icons-alert-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-alert-circle-svg.4cee8264c97045599b56.js"></script> <script async data-chunk="core-icons-webhook-svg" src="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.js"></script> <script async data-chunk="core-icons-chevron-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/2637.a5df1d5e240762d7981f.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/4674.13378da16ce7b5beba66.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/List.12cee315afa198c8e23e.js"></script> <script async data-chunk="routes-Discuss" src="https://cdn.readme.io/public/hub/web/routes-Discuss.6a5b69949f194448cf4f.js"></script> <script async data-chunk="core-icons-trending-up-svg" src="https://cdn.readme.io/public/hub/web/core-icons-trending-up-svg.0dd920b0698e57f75afa.js"></script> <script async data-chunk="core-icons-callout-info-svg" src="https://cdn.readme.io/public/hub/web/core-icons-callout-info-svg.79b14e8568c9cecbc827.js"></script> <script async data-chunk="core-icons-search-svg" src="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"></script> <script async data-chunk="core-icons-custom-pages-svg" src="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/7285.703d773b1bb63ae6e7ee.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.5ccfbee71da134a1eeba.js"></script> <script async data-chunk="rmdx" src="https://cdn.readme.io/public/hub/web/rmdx.594ae0fac8012b876a80.js"></script> <script async data-chunk="Page" src="https://cdn.readme.io/public/hub/web/Page.65c6f721688901333944.js"></script> <script async data-chunk="core-icons-eye-off-svg" src="https://cdn.readme.io/public/hub/web/core-icons-eye-off-svg.b2b8b241b4b324dfd9c1.js"></script> <script async data-chunk="core-icons-star-svg" src="https://cdn.readme.io/public/hub/web/core-icons-star-svg.b834e1612cb2af1e174e.js"></script> <script async data-chunk="routes-Tutorials" src="https://cdn.readme.io/public/hub/web/routes-Tutorials.8adf2bf8562dfeff14b4.js"></script> <script async data-chunk="core-icons-inbox-svg" src="https://cdn.readme.io/public/hub/web/core-icons-inbox-svg.01c2ecb759e417a98bb8.js"></script> <script async data-chunk="core-icons-message-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-message-circle-svg.1e24c2d2eb4f9a6ede5d.js"></script> <script async data-chunk="core-icons-key-svg" src="https://cdn.readme.io/public/hub/web/core-icons-key-svg.71e09670b926900508b8.js"></script> <script async data-chunk="New" src="https://cdn.readme.io/public/hub/web/New.908bc26e77bebc585452.js"></script></div><script async="async" src="https://www.googletagmanager.com/gtag/js?id=G-BD94MKHWRH"></script><script>window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-BD94MKHWRH');</script><script id="hub-me" type="application/json" data-json="{"loggedIn":false,"search":{"app":"T28YKFATPY","token":"OTdiMTFlYjU1Y2UwYzE5YmVkZGMwNWViYzllYWJlZmY5NTJhYWU0MWE5NzRiNGIzMmM2NjQ1YTU1MDFiOTBkNnRhZ0ZpbHRlcnM9KHByb2plY3Q6NjM1NmNlODg3MDMxZmEwMDFlMjZlOTg5KSwodmVyc2lvbjpub25lLHZlcnNpb246NjM1NmNlODg3MDMxZmEwMDFlMjZlOThlKSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlLGluZGV4OkJsb2cp","filters":"tagFilters=(project:6356ce887031fa001e26e989),(version:none,version:6356ce887031fa001e26e98e),(hidden:none,hidden:false),(index:CustomPage,index:Page,index:Blog)","metaData":[{"modules":{"landing":false,"docs":true,"examples":true,"reference":true,"graphql":false,"changelog":true,"discuss":false,"suggested_edits":true,"logs":false,"custompages":false,"tutorials":false},"id":"6356ce887031fa001e26e989","name":"bitpay","subdomain":"bitpay","subpath":"","nav_names":{"docs":"","reference":"API & SDK Documentation","changelog":"","discuss":"","tutorials":"","recipes":""}}]}}"></script><script id="readme-data-baseUrl" type="application/json" data-json=""/""></script></body></html>

CINXE.COM

Getting Started with BitPay