Domain > docs.blockchyp.com

More information on this domain is in AlienVault OTX

DNS Resolutions

Date	IP Address
2019-12-02	13.225.54.124 (ClassC)
2019-12-02	13.225.54.7 (ClassC)
2025-10-29	18.164.116.33 (ClassC)
2025-12-03	3.175.34.91 (ClassC)

HTTP/1.1 200 OKContent-Type: text/htmlContent-Length: 4783728Connection: keep-aliveDate: Wed, 03 Dec 2025 15:55:50 GMTLast-Modified: Wed, 26 Nov 2025 18:33:50 GMTETag: fea319c28e6ffa4a696416069ea1d1eax-amz-server-side-encryption: AES256Accept-Ranges: bytesServer: AmazonS3X-Cache: Miss from cloudfrontVia: 1.1 13db0457431959c4a11b5f54c65b5688.cloudfront.net (CloudFront)X-Amz-Cf-Pop: HIO52-P3X-Amz-Cf-Id: 2s2IwwDkI3I5_wknZy9myZ9T0v2iRaMu21gqiJI5EAk1RV9WFQAdvA

!doctype html>html> head> meta charsetutf-8> meta contentIEedge,chrome1 http-equivX-UA-Compatible> meta nameviewport contentwidthdevice-width, initial-scale1, maximum-scale1> title>BlockChyp Developer Docs/title> style> .highlight table td { padding: 5px; }.highlight table pre { margin: 0; }.highlight .gh { color: #999999;}.highlight .sr { color: #f6aa11;}.highlight .go { color: #888888;}.highlight .gp { color: #555555;}.highlight .gs {}.highlight .gu { color: #aaaaaa;}.highlight .nb { color: #f6aa11;}.highlight .cm { color: #75715e;}.highlight .cp { color: #75715e;}.highlight .c1 { color: #75715e;}.highlight .cs { color: #75715e;}.highlight .c, .highlight .cd { color: #75715e;}.highlight .err { color: #960050;}.highlight .gr { color: #960050;}.highlight .gt { color: #960050;}.highlight .gd { color: #49483e;}.highlight .gi { color: #49483e;}.highlight .ge { color: #49483e;}.highlight .kc { color: #66d9ef;}.highlight .kd { color: #66d9ef;}.highlight .kr { color: #66d9ef;}.highlight .no { color: #66d9ef;}.highlight .kt { color: #66d9ef;}.highlight .mf { color: #ae81ff;}.highlight .mh { color: #ae81ff;}.highlight .il { color: #ae81ff;}.highlight .mi { color: #ae81ff;}.highlight .mo { color: #ae81ff;}.highlight .m, .highlight .mb, .highlight .mx { color: #ae81ff;}.highlight .sc { color: #ae81ff;}.highlight .se { color: #ae81ff;}.highlight .ss { color: #ae81ff;}.highlight .sd { color: #e6db74;}.highlight .s2 { color: #e6db74;}.highlight .sb { color: #e6db74;}.highlight .sh { color: #e6db74;}.highlight .si { color: #e6db74;}.highlight .sx { color: #e6db74;}.highlight .s1 { color: #e6db74;}.highlight .s { color: #e6db74;}.highlight .na { color: #a6e22e;}.highlight .nc { color: #a6e22e;}.highlight .nd { color: #a6e22e;}.highlight .ne { color: #a6e22e;}.highlight .nf { color: #a6e22e;}.highlight .vc { color: #ffffff;}.highlight .nn { color: #ffffff;}.highlight .nl { color: #ffffff;}.highlight .ni { color: #ffffff;}.highlight .bp { color: #ffffff;}.highlight .vg { color: #ffffff;}.highlight .vi { color: #ffffff;}.highlight .nv { color: #ffffff;}.highlight .w { color: #ffffff;}.highlight { color: #ffffff;}.highlight .n, .highlight .py, .highlight .nx { color: #ffffff;}.highlight .ow { color: #f92672;}.highlight .nt { color: #f92672;}.highlight .k, .highlight .kv { color: #f92672;}.highlight .kn { color: #f92672;}.highlight .kp { color: #f92672;}.highlight .o { color: #f92672;} /style> link hrefstylesheets/screen-c9377833.css relstylesheet mediascreen /> link hrefstylesheets/print-bccf8c07.css relstylesheet mediaprint /> script srcjavascripts/all-c5541673.js>/script> /head> body classindex data-languages"shell","go","csharp","java","php","ruby","python","javascript","typescript","objective_c","swift","rust"> a href# idnav-button> span> NAV img srcimages/navbar-cad8cdcb.png altNavbar /> /span> /a> div classtoc-wrapper> img srcimages/logo-d34c1056.png classlogo altLogo /> div classlang-selector> a href# data-language-nameshell>shell/a> a href# data-language-namego>go/a> a href# data-language-namecsharp>csharp/a> a href# data-language-namejava>java/a> a href# data-language-namephp>php/a> a href# data-language-nameruby>ruby/a> a href# data-language-namepython>python/a> a href# data-language-namejavascript>javascript/a> a href# data-language-nametypescript>typescript/a> a href# data-language-nameobjective_c>objective_c/a> a href# data-language-nameswift>swift/a> a href# data-language-namerust>rust/a> /div> div classsearch> input typetext classsearch idinput-search placeholderSearch> /div> ul classsearch-results>/ul> ul idtoc classtoc-list-h1> li> a href#overview classtoc-h1 toc-link data-titleOverview>Overview/a> /li> li> a href#getting-started classtoc-h1 toc-link data-titleGetting Started>Getting Started/a> ul classtoc-list-h2> li> a href#sdks-and-client-libraries classtoc-h2 toc-link data-titleSDKs and Client Libraries>SDKs and Client Libraries/a> /li> li> a href#command-line-interface classtoc-h2 toc-link data-titleCommand Line Interface>Command Line Interface/a> /li> /ul> /li> li> a href#stuff-you-39-ll-need-for-testing classtoc-h1 toc-link data-titleStuff Youll Need For Testing>Stuff Youll Need For Testing/a> ul classtoc-list-h2> li> a href#test-terminals classtoc-h2 toc-link data-titleTest Terminals>Test Terminals/a> /li> li> a href#test-cards classtoc-h2 toc-link data-titleTest Cards>Test Cards/a> /li> li> a href#adverse-event-cards-and-trigger-amounts classtoc-h2 toc-link data-titleAdverse Event Cards and Trigger Amounts>Adverse Event Cards and Trigger Amounts/a> /li> li> a href#testing-unusual-error-conditions classtoc-h2 toc-link data-titleTesting Unusual Error Conditions>Testing Unusual Error Conditions/a> /li> li> a href#test-merchant-accounts classtoc-h2 toc-link data-titleTest Merchant Accounts>Test Merchant Accounts/a> /li> li> a href#activating-terminals classtoc-h2 toc-link data-titleActivating Terminals>Activating Terminals/a> /li> li> a href#api-credentials classtoc-h2 toc-link data-titleAPI Credentials>API Credentials/a> /li> li> a href#the-test-flag classtoc-h2 toc-link data-titleThe Test Flag>The Test Flag/a> /li> /ul> /li> li> a href#payment-api classtoc-h1 toc-link data-titlePayment API>Payment API/a> ul classtoc-list-h2> li> a href#charge classtoc-h2 toc-link data-titleCharge>Charge/a> /li> li> a href#preauthorization classtoc-h2 toc-link data-titlePreauthorization>Preauthorization/a> /li> li> a href#capture-preauthorization classtoc-h2 toc-link data-titleCapture Preauthorization>Capture Preauthorization/a> /li> li> a href#refund classtoc-h2 toc-link data-titleRefund>Refund/a> /li> li> a href#void classtoc-h2 toc-link data-titleVoid>Void/a> /li> li> a href#card-metadata classtoc-h2 toc-link data-titleCard Metadata>Card Metadata/a> /li> li> a href#time-out-reversal classtoc-h2 toc-link data-titleTime Out Reversal>Time Out Reversal/a> /li> li> a href#gift-card-activation classtoc-h2 toc-link data-titleGift Card Activation>Gift Card Activation/a> /li> li> a href#balance classtoc-h2 toc-link data-titleBalance>Balance/a> /li> li> a href#close-batch classtoc-h2 toc-link data-titleClose Batch>Close Batch/a> /li> li> a href#send-payment-link classtoc-h2 toc-link data-titleSend Payment Link>Send Payment Link/a> /li> li> a href#resend-payment-link classtoc-h2 toc-link data-titleResend Payment Link>Resend Payment Link/a> /li> li> a href#cancel-payment-link classtoc-h2 toc-link data-titleCancel Payment Link>Cancel Payment Link/a> /li> li> a href#payment-link-status classtoc-h2 toc-link data-titlePayment Link Status>Payment Link Status/a> /li> li> a href#transaction-status classtoc-h2 toc-link data-titleTransaction Status>Transaction Status/a> /li> li> a href#cash-discount classtoc-h2 toc-link data-titleCash Discount>Cash Discount/a> /li> li> a href#batch-history classtoc-h2 toc-link data-titleBatch History>Batch History/a> /li> li> a href#batch-details classtoc-h2 toc-link data-titleBatch Details>Batch Details/a> /li> li> a href#transaction-history classtoc-h2 toc-link data-titleTransaction History>Transaction History/a> /li> li> a href#list-queued-transactions classtoc-h2 toc-link data-titleList Queued Transactions>List Queued Transactions/a> /li> li> a href#delete-queued-transaction classtoc-h2 toc-link data-titleDelete Queued Transaction>Delete Queued Transaction/a> /li> /ul> /li> li> a href#terminal-api classtoc-h1 toc-link data-titleTerminal API>Terminal API/a> ul classtoc-list-h2> li> a href#terminal-ping classtoc-h2 toc-link data-titleTerminal Ping>Terminal Ping/a> /li> li> a href#terminal-locate classtoc-h2 toc-link data-titleTerminal Locate>Terminal Locate/a> /li> li> a href#terminal-clear classtoc-h2 toc-link data-titleTerminal Clear>Terminal Clear/a> /li> li> a href#terminal-status classtoc-h2 toc-link data-titleTerminal Status>Terminal Status/a> /li> li> a href#capture-signature classtoc-h2 toc-link data-titleCapture Signature>Capture Signature/a> /li> li> a href#new-transaction-display classtoc-h2 toc-link data-titleNew Transaction Display>New Transaction Display/a> /li> li> a href#update-transaction-display classtoc-h2 toc-link data-titleUpdate Transaction Display>Update Transaction Display/a> /li> li> a href#display-message classtoc-h2 toc-link data-titleDisplay Message>Display Message/a> /li> li> a href#boolean-prompt classtoc-h2 toc-link data-titleBoolean Prompt>Boolean Prompt/a> /li> li> a href#text-prompt classtoc-h2 toc-link data-titleText Prompt>Text Prompt/a> /li> li> a href#list-terminals classtoc-h2 toc-link data-titleList Terminals>List Terminals/a> /li> li> a href#deactivate-terminal classtoc-h2 toc-link data-titleDeactivate Terminal>Deactivate Terminal/a> /li> li> a href#activate-terminal classtoc-h2 toc-link data-titleActivate Terminal>Activate Terminal/a> /li> li> a href#reboot-terminal classtoc-h2 toc-link data-titleReboot Terminal>Reboot Terminal/a> /li> /ul> /li> li> a href#terms-amp-conditions-api classtoc-h1 toc-link data-titleTerms & Conditions API>Terms & Conditions API/a> ul classtoc-list-h2> li> a href#terms-amp-conditions-capture classtoc-h2 toc-link data-titleTerms & Conditions Capture>Terms & Conditions Capture/a> /li> li> a href#list-templates classtoc-h2 toc-link data-titleList Templates>List Templates/a> /li> li> a href#get-template classtoc-h2 toc-link data-titleGet Template>Get Template/a> /li> li> a href#update-template classtoc-h2 toc-link data-titleUpdate Template>Update Template/a> /li> li> a href#delete-template classtoc-h2 toc-link data-titleDelete Template>Delete Template/a> /li> li> a href#terms-amp-conditions-log classtoc-h2 toc-link data-titleTerms & Conditions Log>Terms & Conditions Log/a> /li> li> a href#terms-amp-conditions-details classtoc-h2 toc-link data-titleTerms & Conditions Details>Terms & Conditions Details/a> /li> /ul> /li> li> a href#token-api classtoc-h1 toc-link data-titleToken API>Token API/a> ul classtoc-list-h2> li> a href#enroll classtoc-h2 toc-link data-titleEnroll>Enroll/a> /li> li> a href#token-metadata classtoc-h2 toc-link data-titleToken Metadata>Token Metadata/a> /li> li> a href#link-token classtoc-h2 toc-link data-titleLink Token>Link Token/a> /li> li> a href#unlink-token classtoc-h2 toc-link data-titleUnlink Token>Unlink Token/a> /li> li> a href#update-token classtoc-h2 toc-link data-titleUpdate Token>Update Token/a> /li> li> a href#delete-token classtoc-h2 toc-link data-titleDelete Token>Delete Token/a> /li> /ul> /li> li> a href#customer-api classtoc-h1 toc-link data-titleCustomer API>Customer API/a> ul classtoc-list-h2> li> a href#update-customer classtoc-h2 toc-link data-titleUpdate Customer>Update Customer/a> /li> li> a href#retrieve-customer classtoc-h2 toc-link data-titleRetrieve Customer>Retrieve Customer/a> /li> li> a href#search-customer classtoc-h2 toc-link data-titleSearch Customer>Search Customer/a> /li> li> a href#delete-customer classtoc-h2 toc-link data-titleDelete Customer>Delete Customer/a> /li> /ul> /li> li> a href#survey-api classtoc-h1 toc-link data-titleSurvey API>Survey API/a> ul classtoc-list-h2> li> a href#list-questions classtoc-h2 toc-link data-titleList Questions>List Questions/a> /li> li> a href#question-details classtoc-h2 toc-link data-titleQuestion Details>Question Details/a> /li> li> a href#update-question classtoc-h2 toc-link data-titleUpdate Question>Update Question/a> /li> li> a href#delete-question classtoc-h2 toc-link data-titleDelete Question>Delete Question/a> /li> li> a href#survey-results classtoc-h2 toc-link data-titleSurvey Results>Survey Results/a> /li> /ul> /li> li> a href#media-and-branding-api classtoc-h1 toc-link data-titleMedia and Branding API>Media and Branding API/a> ul classtoc-list-h2> li> a href#media-library classtoc-h2 toc-link data-titleMedia Library>Media Library/a> /li> li> a href#upload-media classtoc-h2 toc-link data-titleUpload Media>Upload Media/a> /li> li> a href#upload-status classtoc-h2 toc-link data-titleUpload Status>Upload Status/a> /li> li> a href#get-media-asset classtoc-h2 toc-link data-titleGet Media Asset>Get Media Asset/a> /li> li> a href#delete-media-asset classtoc-h2 toc-link data-titleDelete Media Asset>Delete Media Asset/a> /li> li> a href#list-slide-shows classtoc-h2 toc-link data-titleList Slide Shows>List Slide Shows/a> /li> li> a href#get-slide-show classtoc-h2 toc-link data-titleGet Slide Show>Get Slide Show/a> /li> li> a href#update-slide-show classtoc-h2 toc-link data-titleUpdate Slide Show>Update Slide Show/a> /li> li> a href#delete-slide-show classtoc-h2 toc-link data-titleDelete Slide Show>Delete Slide Show/a> /li> li> a href#terminal-branding classtoc-h2 toc-link data-titleTerminal Branding>Terminal Branding/a> /li> li> a href#update-branding-asset classtoc-h2 toc-link data-titleUpdate Branding Asset>Update Branding Asset/a> /li> li> a href#delete-branding-asset classtoc-h2 toc-link data-titleDelete Branding Asset>Delete Branding Asset/a> /li> /ul> /li> li> a href#merchant-api classtoc-h1 toc-link data-titleMerchant API>Merchant API/a> ul classtoc-list-h2> li> a href#merchant-profile classtoc-h2 toc-link data-titleMerchant Profile>Merchant Profile/a> /li> li> a href#get-merchants classtoc-h2 toc-link data-titleGet Merchants>Get Merchants/a> /li> li> a href#update-merchant classtoc-h2 toc-link data-titleUpdate Merchant>Update Merchant/a> /li> li> a href#merchant-users classtoc-h2 toc-link data-titleMerchant Users>Merchant Users/a> /li> li> a href#invite-merchant-user classtoc-h2 toc-link data-titleInvite Merchant User>Invite Merchant User/a> /li> li> a href#add-gateway-merchant classtoc-h2 toc-link data-titleAdd Gateway Merchant>Add Gateway Merchant/a> /li> li> a href#add-test-merchant classtoc-h2 toc-link data-titleAdd Test Merchant>Add Test Merchant/a> /li> li> a href#delete-test-merchant classtoc-h2 toc-link data-titleDelete Test Merchant>Delete Test Merchant/a> /li> /ul> /li> li> a href#partner-api classtoc-h1 toc-link data-titlePartner API>Partner API/a> ul classtoc-list-h2> li> a href#retrieve-pricing-policy classtoc-h2 toc-link data-titleRetrieve Pricing Policy>Retrieve Pricing Policy/a> /li> li> a href#partner-statements classtoc-h2 toc-link data-titlePartner Statements>Partner Statements/a> /li> li> a href#partner-statement-detail classtoc-h2 toc-link data-titlePartner Statement Detail>Partner Statement Detail/a> /li> li> a href#merchant-invoices classtoc-h2 toc-link data-titleMerchant Invoices>Merchant Invoices/a> /li> li> a href#merchant-invoice-detail classtoc-h2 toc-link data-titleMerchant Invoice Detail>Merchant Invoice Detail/a> /li> li> a href#partner-commission-breakdown classtoc-h2 toc-link data-titlePartner Commission Breakdown>Partner Commission Breakdown/a> /li> li> a href#merchant-credential-generation classtoc-h2 toc-link data-titleMerchant Credential Generation>Merchant Credential Generation/a> /li> li> a href#submit-application classtoc-h2 toc-link data-titleSubmit Application>Submit Application/a> /li> /ul> /li> li> a href#authorization-responses classtoc-h1 toc-link data-titleAuthorization Responses>Authorization Responses/a> /li> li> a href#working-with-signatures classtoc-h1 toc-link data-titleWorking With Signatures>Working With Signatures/a> /li> li> a href#gift-cards classtoc-h1 toc-link data-titleGift Cards>Gift Cards/a> ul classtoc-list-h2> li> a href#third-party-gift-cards classtoc-h2 toc-link data-titleThird Party Gift Cards>Third Party Gift Cards/a> /li> li> a href#bin-range-white-listing classtoc-h2 toc-link data-titleBIN Range White Listing>BIN Range White Listing/a> /li> /ul> /li> li> a href#ebt classtoc-h1 toc-link data-titleEBT>EBT/a> /li> li> a href#cryptocurrency classtoc-h1 toc-link data-titleCryptocurrency>Cryptocurrency/a> ul classtoc-list-h2> li> a href#crypto-response-fields classtoc-h2 toc-link data-titleCrypto Response Fields>Crypto Response Fields/a> /li> li> a href#crypto-batches classtoc-h2 toc-link data-titleCrypto Batches>Crypto Batches/a> /li> li> a href#bitcoin classtoc-h2 toc-link data-titleBitcoin>Bitcoin/a> /li> /ul> /li> li> a href#cash-discounting classtoc-h1 toc-link data-titleCash Discounting>Cash Discounting/a> /li> li> a href#cloud-relay-mode classtoc-h1 toc-link data-titleCloud Relay Mode>Cloud Relay Mode/a> /li> li> a href#store-and-forward classtoc-h1 toc-link data-titleStore and Forward>Store and Forward/a> /li> li> a href#receipt-requirements classtoc-h1 toc-link data-titleReceipt Requirements>Receipt Requirements/a> /li> li> a href#web-tokenizer classtoc-h1 toc-link data-titleWeb Tokenizer>Web Tokenizer/a> /li> li> a href#customers-and-tokens classtoc-h1 toc-link data-titleCustomers and Tokens>Customers and Tokens/a> ul classtoc-list-h2> li> a href#creating-tokens classtoc-h2 toc-link data-titleCreating Tokens>Creating Tokens/a> /li> li> a href#creating-customer-records classtoc-h2 toc-link data-titleCreating Customer Records>Creating Customer Records/a> /li> li> a href#locating-customers-by-payment-method classtoc-h2 toc-link data-titleLocating Customers By Payment Method>Locating Customers By Payment Method/a> /li> li> a href#retrieving-customers classtoc-h2 toc-link data-titleRetrieving Customers>Retrieving Customers/a> /li> li> a href#modifying-token-customer-associations classtoc-h2 toc-link data-titleModifying Token Customer Associations>Modifying Token Customer Associations/a> /li> li> a href#removing-customers-and-tokens classtoc-h2 toc-link data-titleRemoving Customers and Tokens>Removing Customers and Tokens/a> /li> /ul> /li> li> a href#address-verification classtoc-h1 toc-link data-titleAddress Verification>Address Verification/a> /li> li> a href#standard-codes classtoc-h1 toc-link data-titleStandard Codes>Standard Codes/a> ul classtoc-list-h2> li> a href#card-types classtoc-h2 toc-link data-titleCard Types>Card Types/a> /li> li> a href#entry-methods classtoc-h2 toc-link data-titleEntry Methods>Entry Methods/a> /li> /ul> /li> li> a href#rest-api-reference classtoc-h1 toc-link data-titleREST API Reference>REST API Reference/a> ul classtoc-list-h2> li> a href#gateway-api classtoc-h2 toc-link data-titleGateway API>Gateway API/a> /li> li> a href#terminal-api-2 classtoc-h2 toc-link data-titleTerminal API>Terminal API/a> /li> /ul> /li> li> a href#getting-help classtoc-h1 toc-link data-titleGetting Help>Getting Help/a> /li> /ul> ul classtoc-footer> li>a hrefhttps://www.blockchyp.com/login>Login to BlockChyp/a>/li> li>Version 2.25.0/li> /ul> /div> div classpage-wrapper> div classdark-box>/div> div classcontent> h1 idoverview>Overview/h1>p>BlockChyp is a strong>semi-integrated/strong> payment system that makes it easy tointegrate card-present payment terminals with third party software. Usuallythis means on premise retail and restaurant point-of-sale systems, but it can mean justabout anything ranging from cloud based point-of-sale to law and medical practice managementsystems./p>p>strong>Semi-Integrated?/strong>/p>p>strong>Semi-Integrated/strong> is one of many payments industry nonsense terms.In payments lingo, a strong>fully integrated/strong> system means that the paymentterminal is a dumb peripheral and you handle all the authorization and networkcommunication yourself. This puts you in PCI and Level 3 EMV certification scope.You don't want that. You want the terminal to talk directly to our gateway andthe payment networks so your code never touches anything sensitive. The paymentsindustry calls this approach strong>semi-integrated/strong> because that obviously makeseverything crystal clear./p>p>strong>Use Payment Hardware Like A Web Service/strong>/p>p>The idea behind BlockChyp is that you can interact with payment terminal hardwareusing the same techniques you're already used to for other services you consume.BlockChyp allows you to interact with terminal hardware using REST APIs./p>p>But, of course, even REST APIs are too much work these days./p>p>Most developers would rather type a quick command (like code>npm i @blockchyp/blockchyp-js/code>) or dropa dependency snippet in their project somewhere, download a library and go.That's how BlockChyp works.Add one of our SDK libraries to your project and start running transactions, usually within minutes./p>p>The SDKs deal with finding the terminals on your local network or via the cloudand handle all the security and network plumbing you'd have to otherwise build yourself./p>h1 idgetting-started>Getting Started/h1>p>To get started with BlockChyp sign up for a developer account on thea hrefhttps://www.blockchyp.com>BlockChyp Web Site/a> and order a BlockChyp Developer Kit.The kit will include a fully functioning payment terminal along with contactless, chip, mag stripe,and gift test cards./p>aside classwarning>For the time being developer access is invitation only. Contact us atsupport@blockchyp.com if youd like an invitation./aside>p>Next, examine the list of SDKs and Clients and follow the instructions for your technology ecosystem./p>h2 idsdks-and-client-libraries>SDKs and Client Libraries/h2>p>All supported BlockChyp SDKs are open source and hosted on Github. Binaries aredistributed via all the usual package management systems for each platform.(Maven for Java, Nuget for C#, etc.)/p>p>Follow the link for your platform to Github and follow the instructions in theproject README to download the libraries./p>ul>li>a hrefhttps://github.com/blockchyp/blockchyp-csharp>.NET / C# SDK/a>/li>li>a hrefhttps://github.com/blockchyp/blockchyp-go>Go SDK/a>/li>li>a hrefhttps://github.com/blockchyp/blockchyp-js>Javascript SDK/a>/li>li>a hrefhttps://github.com/blockchyp/blockchyp-ts>Typescript SDK/a>/li>li>a hrefhttps://github.com/blockchyp/blockchyp-java>Java SDK/a>/li>li>a hrefhttps://github.com/blockchyp/blockchyp-php>PHP SDK/a>/li>li>a hrefhttps://github.com/blockchyp/blockchyp-python>Python SDK/a>/li>li>a hrefhttps://github.com/blockchyp/blockchyp-ruby>Ruby SDK/a>/li>li>a hrefhttps://github.com/blockchyp/blockchyp-ios>iOS SDK (Swift/Objective-C)/a>/li>li>a hrefhttps://github.com/blockchyp/blockchyp-rust>Rust SDK/a>/li>/ul>p>strong>What if my platform isn't listed?/strong>/p>p>Fear not, the Command Line Interface has you covered./p>p>strong>Y U No C++?/strong>/p>p>We left C/C++ off the SDK list because there are so many different ways to doREST APIs in C++. When you factor in Linux support, it's hard to create aC++ library in such a way that it's suitable for all C++ developers. Wechickened out and hope you understand./p>h2 idcommand-line-interface>Command Line Interface/h2>p>Support for nine of the most popular programming languages is pretty good, butit doesn't cover everybody. Believe it or not, we have some folks using allsorts of wild things like COBOL and Assembler and, of course, C++./p>p>So we've developed an executable command line interface that any language canaccess as a shell command. It's also a good way to experiment with BlockChypwithout writing any code./p>p>Since Go compiles to native code with no extra runtime requirements, we builtthe CLI in Go and it's part of our open source Go SDK.The project includes additional build scripts that create Windowsand Linux command line executables.We also distribute binaries over at Github if you're into that sort of thing./p>p>CLI Links: a hrefhttps://github.com/blockchyp/blockchyp-go/releases>Downloads/a> a hrefhttps://github.com/blockchyp/blockchyp-go/blob/master/docs/cli.md>Docs/a>/p>h1 idstuff-you-39-ll-need-for-testing>Stuff You'll Need For Testing/h1>p>Before you start developing an integration with BlockChyp, you'll need a terminal,some test cards, a test merchant account, and some API credentials.You'll also want to read a quick blurb about the code>test/code> transaction flag./p>h2 idtest-terminals>Test Terminals/h2>p>Hopefully the suits already took care of ordering a Developer Kit for you.If not, login to your developer account and order one. (And since you'vetaken the trouble to read the docs, help yourself to promo code code>RTFM/code> andtake 20% off your developer kit.) The kitincludes a terminal, the necessary cabling, a set of test cards, and an official BlockChypLaptop Sticker. Display it with pride./p>h2 idtest-cards>Test Cards/h2>p>BlockChyp Developer Kits include four EMV test cards with a good mix of CVMs(customer verification methods) and card brands. A few of them are also dualinterface, which means you can use them to run Contactless EMV tests./p>p>We include MSR test cardsfor all four major card brands because mag stripes are still a thing. We alsoinclude three special mag stripe test cards you can use for simulating declines,partial authorizations, and network failures./p>p>The highlight of every Developer Kit is a selection of BlockChyp test gift cards.These use our magical blockchain stuff. Instead of gift card numbers, our giftcard system works by having the terminals sign transaction blocks with keysthat are on the gift card's mag stripe. More on that later./p>aside classsuccess>BlockChyp is compatible with most existing test cards. If you have test cardsfrom another processor or standard B2 test cards, theyll probably work fine./aside>p>strong>Standard Test Card Numbers/strong>/p>p>Because BlockChyp's focus is terminals, you'll want to use real plastic most ofthe time. But, for testing e-commerce and manually entered transactions, any validtest card numbers will work, but we recommend these.../p>table>thead>tr>th>Card Brand/th>th>Card Number/th>th>Cardholder Name/th>th>Expiration/th>th>CVV/th>/tr>/thead>tbody>tr>td>VISA/td>td>4111 1111 1111 1111/td>td>RICHARD HENDRICKS/td>td>12/2025/td>td>000/td>/tr>tr>td>MC/td>td>5105 1051 0510 5118/td>td>JARED DUNN/td>td>12/2025/td>td>000/td>/tr>tr>td>AMEX/td>td>3782 822463 10005/td>td>PETER GREGORY/td>td>12/2025/td>td>0000/td>/tr>tr>td>DISC/td>td>6011 1111 1111 1117/td>td>ERLICH BACHMAN/td>td>12/2025/td>td>000/td>/tr>/tbody>/table>h2 idadverse-event-cards-and-trigger-amounts>Adverse Event Cards and Trigger Amounts/h2>p>Because BlockChyp is compatible with reality, we make it easy to simulate bad things happening. The table belowlists special card numbers and trigger amounts and what adverse eventsthey simulate./p>table>thead>tr>th>Event Type/th>th>Trigger Card/th>th>Trigger Amount/th>th>Notes/th>/tr>/thead>tbody>tr>td>decline/td>td>4111 1111 1111 1129/td>td>201.00/td>td>/td>/tr>tr>td>error/td>td>6011 0009 9013 9424/td>td>00.11/td>td>/td>/tr>tr>td>fraud/td>td>3714 496353 98431/td>td>66.00/td>td>Sets the fraud probability flag/td>/tr>tr>td>partial-auth/td>td>5105 1051 0510 5100/td>td>55.00/td>td>Authorized Amount: $25.00/td>/tr>tr>td>no-response/td>td>4111 1111 1111 1137/td>td>72.00/td>td>Returns no response./td>/tr>tr>td>timeout/td>td>5555 5555 5555 4444/td>td>68.00/td>td>Gateway hangs for 30 seconds./td>/tr>/tbody>/table>p>strong>Believe it or not/strong>, you can customize adverse events. If you don't likeour standard trigger cards or trigger amounts, you can change them or add yourown in the developer portal. You can even have different trigger cards and trigger amounts for differenttest merchant accounts. This means your QA people could have their own setup,which QA people tend to want./p>h2 idtesting-unusual-error-conditions>Testing Unusual Error Conditions/h2>p>There's a lot of chaos in a real world retail environment and things happen out there that can be very difficult to test in development environment. BlockChyp provides a number of specialtricks and flags to assist with simulating unusual scenarios./p>h3 idstore-and-forward-transactions>Store and Forward Transactions/h3>p>To simulate a store and forward transaction, send any transactions to a test merchant account's terminal with an amount consisting of all sevens. For example, 7.77 or 77.77. This permitstesting store and forward scenarios above and below the floor limit. /p>h3 idterminal-connection-resets>Terminal Connection Resets/h3>p>BlockChyp terminals maintain a constant connection to the gateway. These connections are frequently reset as BlockChyp's systems adjust their capacity or if Internetconnections in the field have issues. These connections are reset automatically, usuallywithin seconds, but it's possible for these connections to reset in the middle of atransaction, which can disrupt the point-of-sale system's ability to receive a validresponse, especially in Cloud Relay Mode./p>p>BlockChyp has backup logic in place to minimize unexpected behavior in these conditions,but it's still wise to test it. By adding the code>-resetConnection/code> flag to a test cloudrelay transaction, the terminal connection will be intentionally dropped in the middle of the correspondingtransaction. This gives developers the ability to test how the system will behavein the worst case scenario. Note that if you run your terminals in local mode, theseconnection resets will have little or no impact./p>h3 idsimulating-post-auth-chip-rejections>Simulating Post Auth Chip Rejections/h3>p>Under the EMV standard it's possible for the chip to reject a transaction afterit's been authorized due to issuer specific rules, triggering an automatic reversal. This is a tricky thing to simulate, so we've added a special code>-chipRejection/code> flag that can force the terminal to behave as if the chip rejected a transaction after authorization. The transaction will be authorizedand immediately reversed./p>h3 idsimulating-out-of-order-reversals>Simulating Out of Order Reversals/h3>p>Transaction reversals normally work by instructing the gateway to reverse a transactionimmediately after authorization. In shaky network conditions, it's possible that areversal packet might arrive at the gateway before the original authorization./p>p>If this possibility weren't properly accounted for, the point-of-sale system wouldthink the transaction had been reversed since the reversal succeeded, while the originaltransaction would stand as authorized./p>p>BlockChyp has systems in place to detect and correct for out of order reversals andthere's no special coding required to handle it on the part of point-of-sale developers,but test transactions can be sent with an code>-outOfOrderReversal/code> flag that will forcea terminal transaction to send a reversal before it sends the authorization, so developerscan verify and test the behavior for themselves./p>h3 idenabling-asynchronous-auto-reversals>Enabling Asynchronous Auto-Reversals/h3>p>Terminal triggered auto-reversals are synchronous by default, meaning that transaction API calls block until any auto-reversals are complete. This cancause transaction timeouts on shaky networks since auto-reversals are attemptedfive times with a fifteen second delay between attempts./p>p>By sending an optional code>-asyncReversals/code> flag with a transaction, developers can force auto-reversals to execute in a separate and asynchronous thread. This is normally not desirable since it can hide the fact that a reversal even occurredfrom the original API call./p>p>Developers who use the code>-asyncReversals/code> flag should always verify the statusof transactions via the transaction status API shortly after the transactionis completed or prior to batch closure./p>h2 idtest-merchant-accounts>Test Merchant Accounts/h2>p>Once you have all the gear and test plastic, you'll need to create a test merchant account. Justlogin into the BlockChyp portal, expand strong>Developer Tools/strong> and click strong>Test Merchants/strong>. You'll be ableto add a test merchant from there./p>p>When you click on a test merchant, you'll notice you get a Merchant Tools section on yournavigation just like live merchants. You can adjust merchant settings here and uploadmedia to troll your peers with. You'll also notice a Test Settings button on the test merchantlanding page. This allows access to restricted settings that you wouldn't have access tofor live merchants, but might need to tweak for testing different scenarios./p>h2 idactivating-terminals>Activating Terminals/h2>p>Next, pair your terminal with the test merchant account by touching the terminal screen where itsays "TOUCH TO ACTIVATE". Click ACTIVATE TERMINAL on the test merchant dashboard and enter the codeyou see on the terminal. Give the terminal a name and decide whether or not you'll be using theterminal in cloud relay mode. If your application is web based or won't be residing on the samenetwork as the terminal, check the box. Otherwise, leave it be./p>aside classinfo>b>Dont I need to assign my terminal an IP address?/b>p>Actually, no. Theres aterminal name resolution system baked into the SDK libraries and CLI. We alwaysrecommend a static IP, but we know that in the chaotic world of retail that isnt always realistic.Your support folks probably dont want to spend hours talking technology averse merchantsthrough custom network configuration and neither do we./p>/aside>h2 idapi-credentials>API Credentials/h2>p>The final step before you can start coding is to generate API credentials. Justclick the API CREDENTIALS button and generate a new set of credentials. You canhave any number of unique credentials for a given merchant account. You can alsolock them to protect them from accidental deletion or add some notes to remindyourself about how you might be using the credentials./p>p>When you generate credentials, you get three things for the price of one click:/p>ul>li>API Key: This is a unique key that identifies a set of credentials./li>li>Bearer Token: A secure access token that gets passed over the network with every request. Keep this in a secure place./li>li>Signing Key: This is a special key used by the SDKs to create HMAC signatures for every request. You should also keep this in a secure place./li>/ul>aside classinfo>b>Credential Types and Roles/b>p>Credentials can be generated for Merchants, Partners, and Organizations. They can likewise beassigned one or more security roles. Consult the documentation for each API endpoint to confirmthe credential types and roles required./p>/aside>aside classwarning>b>Bearer Tokens and Signing Keys are Readable Only Once!/b>p>Bearer Tokens and Signing Keys are readable only when you create them. If you misplaceyour credentials, youll have to create new ones./p>/aside>aside classinfo>b>Why Three Credentials?/b>p>Hackers love payment systems, so we like to practice defense in depth.Secure Tokens and HMAC Headers each have their pros and cons from a securityperspective, so we just use both./p>p>The weakest link in the chain is actually how you choose to store the credentialsin your system. We humbly request that you store them using some strong symmetricencryption like AES-256 with multiple sources of key entropy./p>/aside>h2 idthe-test-flag>The Test Flag/h2>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -typespan classo>/span>span classs2>charge/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -amountspan classo>/span>span classs2>2.59/span> -testWindows: blockchyp.exe -typespan classo>/span>span classs2>charge/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -amountspan classo>/span>span classs2>2.59/span> -test/code>/pre>pre classhighlight go tab-go>code>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>AuthorizationRequest/span>span classp>{/span>span classx> /span>span classn>Test/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classc>//setting the test flag/span>span classx> /span>span classn>TerminalName/span>span classo>:/span>span classx> /span>span classs>Test Terminal/span>span classp>,/span>span classx> /span>span classn>Amount/span>span classo>:/span>span classx> /span>span classs>55.00/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>Charge/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classn>AuthorizationRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>AuthorizationRequest/span>span classp>{/span> span classn>Test/span> span classp>/span> span classk>true/span>span classp>,/span> span classn>TerminalName/span> span classp>/span> span classs>Test Terminal/span>span classp>,/span> span classc1>//setting the test flag/span> span classn>Amount/span> span classp>/span> span classs>55.00/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>AuthorizationResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>ChargeAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classn>AuthorizationRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>AuthorizationRequest/span>span classo>();/span>span classn>request/span>span classo>./span>span classna>setTest/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classc1>//setting the test flag/span>span classn>request/span>span classo>./span>span classna>setTerminalName/span>span classo>(/span>span classs>Test Terminal/span>span classo>);/span>span classn>request/span>span classo>./span>span classna>setAmount/span>span classo>(/span>span classs>55.00/span>span classo>);/span>span classc1>// Send the request/span>span classn>AuthorizationResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>charge/span>span classo>(/span>span classn>request/span>span classo>);/span>/code>/pre>pre classhighlight php tab-php>code>$request test > true, //setting the test flag terminalName > Test Terminal, amount > 55.00,;$response BlockChyp::charge($request);/code>/pre>p>The astute payment integration veterans among you may have noted that we don'task you to put a Gateway URL anywhere in your configuration. You're welcome,but PCI "law" forbids processing test transactions on the same servers aslive transactions./p>p>For this reason, all test transactions must be flagged at test transactions. Allsample code in this documentation will include the test flag because we assumeyou use the documentation while testing, but you'll need to remove it when youstart running transactions for live merchants./p>p>The sample code shows how you set the test flag on platforms./p>aside classwarning>b>Remove The Test Flag For Live Accounts/b>p>Make sure you remove the test flag when you run live transactions. Yourconfiguration UI should probably include a check box to flagtest accounts./p>/aside>h1 idpayment-api>Payment API/h1>p>These are the core payment APIs used to execute and work with payment transactions in BlockChyp./p>h2 idcharge>Charge/h2>blockquote>p>Charge Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>charge/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -amountspan classo>/span>span classs2>25.00/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>charge/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -amountspan classo>/span>span classs2>25.00/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>chargeExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>AuthorizationRequest/span>span classp>{/span>span classx> /span>span classn>Test/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classn>TerminalName/span>span classo>:/span>span classx> /span>span classs>Test Terminal/span>span classp>,/span>span classx> /span>span classn>Amount/span>span classo>:/span>span classx> /span>span classs>55.00/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>Charge/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Approved/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>approved/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>AuthorizationRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>AuthorizationRequest/span>span classp>{/span> span classn>Test/span> span classp>/span> span classk>true/span>span classp>,/span> span classn>TerminalName/span> span classp>/span> span classs>Test Terminal/span>span classp>,/span> span classn>Amount/span> span classp>/span> span classs>55.00/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>AuthorizationResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>ChargeAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.AuthorizationRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.AuthorizationResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>ChargeExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>AuthorizationRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>AuthorizationRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTest/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setTerminalName/span>span classo>(/span>span classs>Test Terminal/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setAmount/span>span classo>(/span>span classs>55.00/span>span classo>);/span> span classc1>// Send the request/span> span classn>AuthorizationResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>charge/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>test/span> span classo>>/span> span classkc>true/span>span classp>,/span> span classs1>terminalName/span> span classo>>/span> span classs1>Test Terminal/span>span classp>,/span> span classs1>amount/span> span classo>>/span> span classs1>55.00/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>charge/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>test: /span>span classkp>true/span>span classp>,/span> span classss>terminalName: /span>span classs1>Test Terminal/span>span classp>,/span> span classss>amount: /span>span classs1>55.00/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>charge/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>test/span>span classp>:/span> span classbp>True/span>span classp>,/span> span classs>terminalName/span>span classp>:/span> span classs>Test Terminal/span>span classp>,/span> span classs>amount/span>span classp>:/span> span classs>55.00/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>charge/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>charge/span>span classp>({/span> span classna>test/span>span classp>:/span> span classkc>true/span>span classp>,/span> span classna>terminalName/span>span classp>:/span> span classs1>Test Terminal/span>span classp>,/span> span classna>amount/span>span classp>:/span> span classs1>55.00/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>AuthorizationRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>test/span> span classo>/span> span classkc>true/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>terminalName/span> span classo>/span> span classs1>Test Terminal/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>amount/span> span classo>/span> span classs1>55.00/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>charge/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>AuthorizationResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classnb>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>request/span>span classp>/span>span classs>amount/span>span classp>/span> span classo>/span> span classs>55.00/span> span classp>/span>span classn>client/span> span classnf>chargeWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@approved/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@approved/span>span classp>);/span> span classp>}/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@authCode/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@authCode/span>span classp>)/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@authorizedAmount/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@authorizedAmount/span>span classp>)/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classkc>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>request/span>span classp>/span>span classs>amount/span>span classp>/span> span classo>/span> span classs>55.00/span> span classn>client/span>span classo>./span>span classnf>charge/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>approved/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>approved/span>span classp>)/span> span classp>}/span> span classkt>NSLog/span>span classp>(/span>span classs>authCode/span> span classo>+/span> span classs>: /span> span classo>+/span> span classp>(/span>span classn>response/span>span classp>/span>span classs>authCode/span>span classp>/span> span classk>as?/span> span classkt>String/span>span classp>)/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classkt>NSLog/span>span classp>(/span>span classs>authorizedAmount/span> span classo>+/span> span classs>: /span> span classo>+/span> span classp>(/span>span classn>response/span>span classp>/span>span classs>authorizedAmount/span>span classp>/span> span classk>as?/span> span classkt>String/span>span classp>)/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>charge_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classk>mut/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>AuthorizationRequest/span>span classp>{/span> span classn>test/span>span classp>:/span> span classk>true/span>span classp>,/span> span classn>terminal_name/span>span classp>:/span> span classs>Test Terminal/span>span classnf>.to_string/span>span classp>(),/span> span classn>amount/span>span classp>:/span> span classs>55.00/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.charge/span>span classp>(/span>span classo>&/span>span classk>mut/span> span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.approved/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>approved/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>charge_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>approved/span>span classp>,/span>span classw> /span>span classs2>approved/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>authCode/span>span classp>:/span>span classw> /span>span classs2>052509/span>span classp>,/span>span classw> /span>span classs2>transactionId/span>span classp>:/span>span classw> /span>span classs2>KJ3DPHULBAI6VOTSNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>transactionRef/span>span classp>:/span>span classw> /span>span classs2>04781125618/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>charge/span>span classp>,/span>span classw> /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classs2>2020-04-30T18:28:10Z/span>span classp>,/span>span classw> /span>span classs2>tickBlock/span>span classp>:/span>span classw> /span>span classs2>009991a8ac7b6a4420760e1e14e1689c88be2a610a033d6908c1b04b5c00f9da/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>partialAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>altCurrency/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>fsaAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>currencyCode/span>span classp>:/span>span classw> /span>span classs2>USD/span>span classp>,/span>span classw> /span>span classs2>requestedAmount/span>span classp>:/span>span classw> /span>span classs2>25.00/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>25.00/span>span classp>,/span>span classw> /span>span classs2>remainingBalance/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>tipAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>taxAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>requestedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>authorizedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>CHIP/span>span classp>,/span>span classw> /span>span classs2>paymentType/span>span classp>:/span>span classw> /span>span classs2>VISA/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************0010/span>span classp>,/span>span classw> /span>span classs2>cardHolder/span>span classp>:/span>span classw> /span>span classs2>UAT USA/Test Card 04/span>span classp>,/span>span classw> /span>span classs2>avsResponse/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>receiptSuggestions/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>aid/span>span classp>:/span>span classw> /span>span classs2>A0000000031010/span>span classp>,/span>span classw> /span>span classs2>arqc/span>span classp>:/span>span classw> /span>span classs2>BDFD1A64620D9382/span>span classp>,/span>span classw> /span>span classs2>iad/span>span classp>:/span>span classw> /span>span classs2>06010A03A0B800/span>span classp>,/span>span classw> /span>span classs2>tvr/span>span classp>:/span>span classw> /span>span classs2>8000008800/span>span classp>,/span>span classw> /span>span classs2>tsi/span>span classp>:/span>span classw> /span>span classs2>6800/span>span classp>,/span>span classw> /span>span classs2>merchantName/span>span classp>:/span>span classw> /span>span classs2>Test Merchant/span>span classp>,/span>span classw> /span>span classs2>applicationLabel/span>span classp>:/span>span classw> /span>span classs2>VISA CREDIT/span>span classp>,/span>span classw> /span>span classs2>requestSignature/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************0010/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>25.00/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>charge/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>CHIP/span>span classp>,/span>span classw> /span>span classs2>cashBackAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>surcharge/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>cashDiscount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>customer/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>whiteListedCard/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>storeAndForward/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>Our most popular transaction executes a standard authorization and capture.This is the most basic ofbasic payment transactions, typically used in conventional retail./p>p>Charge transactions can use a payment terminal to capture a payment oruse a previously enrolled payment token./p>p>strong>Terminal Transactions/strong>/p>p>For terminal transactions, make sure you pass in the terminal name using the code>terminalName/code> property./p>p>strong>Token Transactions/strong>/p>p>If you have a payment token, omit the code>terminalName/code> property and pass in the token with the code>token/code>property instead./p>p>strong>Card Numbers and Mag Stripes/strong>/p>p>You can also pass in PANs and Mag Stripes, but you probably shouldn't, as this willput you in PCI scope and the most common vector for POS breaches is keylogging.If you use terminals for manual card entry, you'll bypass any keyloggers thatmight be maliciously running on the point-of-sale system./p>p>strong>Common Variations/strong>/p>ul>li>strong>Gift Card Redemption/strong>: There's no special API for gift card redemption in BlockChyp. Simply execute a plain charge transaction and if the customer swipes a gift card, our terminals will identify the gift card and run a gift card redemption. Also note that if for some reason the gift card's original purchase transaction is associated with fraud or a chargeback, the transaction will be rejected./li>li>strong>EBT/strong>: Set the code>CardType/code> field to code>blockchyp.CardTypeEBT/code> to process an EBT SNAP transaction. Note that test EBT transactions always assume a balance of $100.00, so test EBT transactions over that amount may be declined./li>li>strong>Cash Back/strong>: To enable cash back for debit transactions, set the code>CashBack/code> field. If the card presented isn't a debit card, the code>CashBack/code> field will be ignored./li>li>strong>Manual Card Entry/strong>: Set the code>ManualEntry/code> field to enable manual card entry. Good as a backup when chips and MSR's don't work or for more secure phone orders. You can even combine the code>ManualEntry/code> field with the code>CardType/code> field set to code>blockchyp.CardTypeEBT/code> for manual EBT card entry./li>li>strong>Inline Tokenization/strong>: You can enroll the payment method in the token vault inline with a charge transaction by setting the code>Enroll/code> field. You'll get a token back in the response. You can even bind the token to a customer record if you also pass in customer data./li>li>strong>Prompting for Tips/strong>: Set the code>PromptForTip/code> field if you'd like to prompt the customer for a tip before authorization. Good for pay-at-the-table and other service related scenarios./li>li>strong>Cash Discounting and Surcharging/strong>: The code>Surcharge/code> and code>CashDiscount/code> fields can be used together to support cash discounting or surcharge problems. Consult the Cash Discount documentation for more details./li>li>strong>Cryptocurrency/strong> The code>Cryptocurrency/code> field can be used to switch the standard present card screen to a cryptocurrency screen. The field value can be code>ANY/code> to enable any supported cryptocurrency or a single currency code such as code>BTC/code> for Bitcoin./li>/ul>aside classwarning>Note that if you pass mag stripes or account numbers into a charge transaction, youwill be in PCI scope. If you need to capture manual or phone payments,consider using the terminal with the b>manual/b> flag set for improved security. Use theBlockChyp Web Tokenizer to stay out of scope for e-commerce transactions./aside>h2 idpreauthorization>Preauthorization/h2>blockquote>p>Preauthorization Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>preauth/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -amountspan classo>/span>span classs2>27.00/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>preauth/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -amountspan classo>/span>span classs2>27.00/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>preauthExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>AuthorizationRequest/span>span classp>{/span>span classx> /span>span classn>Test/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classn>TerminalName/span>span classo>:/span>span classx> /span>span classs>Test Terminal/span>span classp>,/span>span classx> /span>span classn>Amount/span>span classo>:/span>span classx> /span>span classs>27.00/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>Preauth/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Approved/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>approved/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>AuthorizationRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>AuthorizationRequest/span>span classp>{/span> span classn>Test/span> span classp>/span> span classk>true/span>span classp>,/span> span classn>TerminalName/span> span classp>/span> span classs>Test Terminal/span>span classp>,/span> span classn>Amount/span> span classp>/span> span classs>27.00/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>AuthorizationResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>PreauthAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.AuthorizationRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.AuthorizationResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>PreauthExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>AuthorizationRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>AuthorizationRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTest/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setTerminalName/span>span classo>(/span>span classs>Test Terminal/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setAmount/span>span classo>(/span>span classs>27.00/span>span classo>);/span> span classc1>// Send the request/span> span classn>AuthorizationResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>preauth/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>test/span> span classo>>/span> span classkc>true/span>span classp>,/span> span classs1>terminalName/span> span classo>>/span> span classs1>Test Terminal/span>span classp>,/span> span classs1>amount/span> span classo>>/span> span classs1>27.00/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>preauth/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>test: /span>span classkp>true/span>span classp>,/span> span classss>terminalName: /span>span classs1>Test Terminal/span>span classp>,/span> span classss>amount: /span>span classs1>27.00/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>preauth/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>test/span>span classp>:/span> span classbp>True/span>span classp>,/span> span classs>terminalName/span>span classp>:/span> span classs>Test Terminal/span>span classp>,/span> span classs>amount/span>span classp>:/span> span classs>27.00/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>preauth/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>preauth/span>span classp>({/span> span classna>test/span>span classp>:/span> span classkc>true/span>span classp>,/span> span classna>terminalName/span>span classp>:/span> span classs1>Test Terminal/span>span classp>,/span> span classna>amount/span>span classp>:/span> span classs1>27.00/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>AuthorizationRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>test/span> span classo>/span> span classkc>true/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>terminalName/span> span classo>/span> span classs1>Test Terminal/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>amount/span> span classo>/span> span classs1>27.00/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>preauth/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>AuthorizationResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classnb>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>request/span>span classp>/span>span classs>amount/span>span classp>/span> span classo>/span> span classs>27.00/span> span classp>/span>span classn>client/span> span classnf>preauthWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@approved/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@approved/span>span classp>);/span> span classp>}/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@authCode/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@authCode/span>span classp>)/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@authorizedAmount/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@authorizedAmount/span>span classp>)/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classkc>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>request/span>span classp>/span>span classs>amount/span>span classp>/span> span classo>/span> span classs>27.00/span> span classn>client/span>span classo>./span>span classnf>preauth/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>approved/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>approved/span>span classp>)/span> span classp>}/span> span classkt>NSLog/span>span classp>(/span>span classs>authCode/span> span classo>+/span> span classs>: /span> span classo>+/span> span classp>(/span>span classn>response/span>span classp>/span>span classs>authCode/span>span classp>/span> span classk>as?/span> span classkt>String/span>span classp>)/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classkt>NSLog/span>span classp>(/span>span classs>authorizedAmount/span> span classo>+/span> span classs>: /span> span classo>+/span> span classp>(/span>span classn>response/span>span classp>/span>span classs>authorizedAmount/span>span classp>/span> span classk>as?/span> span classkt>String/span>span classp>)/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>preauth_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classk>mut/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>AuthorizationRequest/span>span classp>{/span> span classn>test/span>span classp>:/span> span classk>true/span>span classp>,/span> span classn>terminal_name/span>span classp>:/span> span classs>Test Terminal/span>span classnf>.to_string/span>span classp>(),/span> span classn>amount/span>span classp>:/span> span classs>27.00/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.preauth/span>span classp>(/span>span classo>&/span>span classk>mut/span> span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.approved/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>approved/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>preauth_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>approved/span>span classp>,/span>span classw> /span>span classs2>approved/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>authCode/span>span classp>:/span>span classw> /span>span classs2>462305/span>span classp>,/span>span classw> /span>span classs2>transactionId/span>span classp>:/span>span classw> /span>span classs2>KJ3DPHULBAI6VOTTNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>transactionRef/span>span classp>:/span>span classw> /span>span classs2>22265850802/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>preauth/span>span classp>,/span>span classw> /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classs2>2020-04-30T18:36:21Z/span>span classp>,/span>span classw> /span>span classs2>tickBlock/span>span classp>:/span>span classw> /span>span classs2>009991a8ac7b6a4420760e1e14e1689c88be2a610a033d6908c1b04b5c00f9da/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>partialAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>altCurrency/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>fsaAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>currencyCode/span>span classp>:/span>span classw> /span>span classs2>USD/span>span classp>,/span>span classw> /span>span classs2>requestedAmount/span>span classp>:/span>span classw> /span>span classs2>27.00/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>27.00/span>span classp>,/span>span classw> /span>span classs2>remainingBalance/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>tipAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>taxAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>requestedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>authorizedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>CHIP/span>span classp>,/span>span classw> /span>span classs2>paymentType/span>span classp>:/span>span classw> /span>span classs2>VISA/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************0010/span>span classp>,/span>span classw> /span>span classs2>cardHolder/span>span classp>:/span>span classw> /span>span classs2>UAT USA/Test Card 04/span>span classp>,/span>span classw> /span>span classs2>avsResponse/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>receiptSuggestions/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>aid/span>span classp>:/span>span classw> /span>span classs2>A0000000031010/span>span classp>,/span>span classw> /span>span classs2>arqc/span>span classp>:/span>span classw> /span>span classs2>F1D11638D5A4C91D/span>span classp>,/span>span classw> /span>span classs2>iad/span>span classp>:/span>span classw> /span>span classs2>06010A03A0B800/span>span classp>,/span>span classw> /span>span classs2>tvr/span>span classp>:/span>span classw> /span>span classs2>8000008800/span>span classp>,/span>span classw> /span>span classs2>tsi/span>span classp>:/span>span classw> /span>span classs2>6800/span>span classp>,/span>span classw> /span>span classs2>merchantName/span>span classp>:/span>span classw> /span>span classs2>Test Merchant/span>span classp>,/span>span classw> /span>span classs2>applicationLabel/span>span classp>:/span>span classw> /span>span classs2>VISA CREDIT/span>span classp>,/span>span classw> /span>span classs2>requestSignature/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************0010/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>27.00/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>preauth/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>CHIP/span>span classp>,/span>span classw> /span>span classs2>cashBackAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>surcharge/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>cashDiscount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>customer/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>whiteListedCard/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>storeAndForward/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>A preauthorization puts a hold on funds and must be captured later. This is usedin scenarios where the final transaction amount might change. A common example is fine dining, where a tip adjustment is required before final settlement./p>p>Another use case for preauthorization is e-commerce. Typically, an online orderis preauthorized at the time of the order and then captured when the order ships./p>p>Preauthorizations can use a payment terminal to capture a payment oruse a previously enrolled payment token./p>p>strong>Terminal Transactions/strong>/p>p>For terminal transactions, make sure you pass in the terminal name using the code>terminalName/code> property./p>p>strong>Token Transactions/strong>/p>p>If you have a payment token, omit the code>terminalName/code> property and pass in the token with the code>token/code>property instead./p>p>strong>Card Numbers and Mag Stripes/strong>/p>p>You can also pass in PANs and Mag Stripes, but you probably shouldn't, as this willput you in PCI scope and the most common vector for POS breaches is key logging.If you use terminals for manual card entry, you'll bypass any key loggers thatmight be maliciously running on the point-of-sale system./p>p>strong>Cryptocurrency/strong>/p>p>Note that preauths are not supported for cryptocurrency./p>p>strong>Common Variations/strong>/p>ul>li>strong>Manual Card Entry/strong>: Set the code>ManualEntry/code> field to enable manual card entry. Good as a backup when chips and MSR's don't work or for more secure phone orders. You can even combine the code>ManualEntry/code> field with code>CardType/code> set to code>blockchyp.CardTypeEBT/code> for manual EBT card entry./li>li>strong>Inline Tokenization/strong>: You can enroll the payment method in the token vault in line with a charge transaction by setting the code>Enroll/code> field. You'll get a token back in the response. You can even bind the token to a customer record if you also pass in customer data./li>li>strong>Prompting for Tips/strong>: Set the code>PromptForTip/code> field if you'd like to prompt the customer for a tip before authorization. You can prompt for tips as part of a preauthorization, although it's not a very common approach./li>li>strong>Cash Discounting and Surcharging/strong>: The code>Surcharge/code> and code>CashDiscount/code> fields can be used together to support cash discounting or surcharge problems. Consult the Cash Discount documentation for more details./li>/ul>aside classwarning>If you pass mag stripes or account numbers into a preauth transaction, youwill be in PCI scope. If you need to capture manual or phone payments,consider using the terminal with the b>manual/b> flag set for improved security. Use theBlockChyp Web Tokenizer to stay out of scope for e-commerce transactions./aside>h2 idcapture-preauthorization>Capture Preauthorization/h2>blockquote>p>Capture Preauthorization Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>capture/span> -txspan classo>/span>span classs2><ORIGINAL TRANSACTION ID>/span> -tipspan classo>/span>span classs2>5.00/span> -amountspan classo>/span>span classs2>32.00/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>capture/span> -txspan classo>/span>span classs2><ORIGINAL TRANSACTION ID>/span> -tipspan classo>/span>span classs2>5.00/span> -amountspan classo>/span>span classs2>32.00/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>captureExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>CaptureRequest/span>span classp>{/span>span classx> /span>span classn>Test/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classn>TransactionID/span>span classo>:/span>span classx> /span>span classs><ORIGINAL TRANSACTION ID>/span>span classp>,/span>span classx> /span>span classn>Amount/span>span classo>:/span>span classx> /span>span classs>32.00/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>Capture/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Approved/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>approved/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>CaptureRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>CaptureRequest/span>span classp>{/span> span classn>Test/span> span classp>/span> span classk>true/span>span classp>,/span> span classn>TransactionId/span> span classp>/span> span classs><ORIGINAL TRANSACTION ID>/span>span classp>,/span> span classn>Amount/span> span classp>/span> span classs>32.00/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>CaptureResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>CaptureAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.CaptureRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.CaptureResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>CaptureExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>CaptureRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>CaptureRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTest/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setTransactionId/span>span classo>(/span>span classs><ORIGINAL TRANSACTION ID>/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setAmount/span>span classo>(/span>span classs>32.00/span>span classo>);/span> span classc1>// Send the request/span> span classn>CaptureResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>capture/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>test/span> span classo>>/span> span classkc>true/span>span classp>,/span> span classs1>transactionId/span> span classo>>/span> span classs1><ORIGINAL TRANSACTION ID>/span>span classp>,/span> span classs1>amount/span> span classo>>/span> span classs1>32.00/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>capture/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>test: /span>span classkp>true/span>span classp>,/span> span classss>transactionId: /span>span classs1><ORIGINAL TRANSACTION ID>/span>span classp>,/span> span classss>amount: /span>span classs1>32.00/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>capture/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>test/span>span classp>:/span> span classbp>True/span>span classp>,/span> span classs>transactionId/span>span classp>:/span> span classs><ORIGINAL TRANSACTION ID>/span>span classp>,/span> span classs>amount/span>span classp>:/span> span classs>32.00/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>capture/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>capture/span>span classp>({/span> span classna>test/span>span classp>:/span> span classkc>true/span>span classp>,/span> span classna>transactionId/span>span classp>:/span> span classs1><ORIGINAL TRANSACTION ID>/span>span classp>,/span> span classna>amount/span>span classp>:/span> span classs1>32.00/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>CaptureRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>test/span> span classo>/span> span classkc>true/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>transactionId/span> span classo>/span> span classs1><ORIGINAL TRANSACTION ID>/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>amount/span> span classo>/span> span classs1>32.00/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>capture/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>CaptureResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classnb>true/span> span classn>request/span>span classp>/span>span classs>transactionId/span>span classp>/span> span classo>/span> span classs><ORIGINAL TRANSACTION ID>/span> span classn>request/span>span classp>/span>span classs>amount/span>span classp>/span> span classo>/span> span classs>32.00/span> span classp>/span>span classn>client/span> span classnf>captureWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@approved/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@approved/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classkc>true/span> span classn>request/span>span classp>/span>span classs>transactionId/span>span classp>/span> span classo>/span> span classs><ORIGINAL TRANSACTION ID>/span> span classn>request/span>span classp>/span>span classs>amount/span>span classp>/span> span classo>/span> span classs>32.00/span> span classn>client/span>span classo>./span>span classnf>capture/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>approved/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>approved/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>capture_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>CaptureRequest/span>span classp>{/span> span classn>test/span>span classp>:/span> span classk>true/span>span classp>,/span> span classn>transaction_id/span>span classp>:/span> span classs><ORIGINAL TRANSACTION ID>/span>span classnf>.to_string/span>span classp>(),/span> span classn>amount/span>span classp>:/span> span classs>32.00/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.capture/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.approved/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>approved/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>capture_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>approved/span>span classp>,/span>span classw> /span>span classs2>approved/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>authCode/span>span classp>:/span>span classw> /span>span classs2>337092/span>span classp>,/span>span classw> /span>span classs2>transactionId/span>span classp>:/span>span classw> /span>span classs2>KJ3DPHULBAI6VOTUNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>KJ3DPFELBAI6VOTRNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>capture/span>span classp>,/span>span classw> /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classs2>2020-04-30T19:03:00Z/span>span classp>,/span>span classw> /span>span classs2>tickBlock/span>span classp>:/span>span classw> /span>span classs2>009991a8ac7b6a4420760e1e14e1689c88be2a610a033d6908c1b04b5c00f9da/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>partialAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>altCurrency/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>fsaAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>currencyCode/span>span classp>:/span>span classw> /span>span classs2>USD/span>span classp>,/span>span classw> /span>span classs2>requestedAmount/span>span classp>:/span>span classw> /span>span classs2>32.00/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>32.00/span>span classp>,/span>span classw> /span>span classs2>remainingBalance/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>tipAmount/span>span classp>:/span>span classw> /span>span classs2>5.00/span>span classp>,/span>span classw> /span>span classs2>taxAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>requestedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>authorizedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>CHIP/span>span classp>,/span>span classw> /span>span classs2>paymentType/span>span classp>:/span>span classw> /span>span classs2>VISA/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************0010/span>span classp>,/span>span classw> /span>span classs2>avsResponse/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>receiptSuggestions/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>requestSignature/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>customer/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API allows you to capture a previously approved preauthorization./p>p>You'll need to make sure you pass in the Transaction ID returned by the original preauth transaction so we know which transaction we're capturing. If you want to capture the transaction for theexact amount of the preauth, the Transaction ID is all you need to pass in./p>p>You can adjust the total if you need to by passing in a new code>amount/code>. Wealso recommend you pass in updated amounts for code>tax/code> and code>tip/code> as it cansometimes reduce your interchange fees. (Level II Processing, for example.)/p>aside classwarning>Try to capture your preauths on the same batch if you can. The card brandscharge higher interchange rates for transactions captured 24 hours after theoriginal preauthorization. We know that this isnt realistic in some industries like hotels or e-commerce, but we wanted you to know about this potential gotcha./aside>h2 idrefund>Refund/h2>blockquote>p>Refund Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>refund/span> -txspan classo>/span>span classs2><PREAUTH TRANSACTION ID>/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>refund/span> -txspan classo>/span>span classs2><PREAUTH TRANSACTION ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>refundExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>RefundRequest/span>span classp>{/span>span classx> /span>span classn>TransactionID/span>span classo>:/span>span classx> /span>span classs><PREVIOUS TRANSACTION ID>/span>span classp>,/span>span classx> /span>span classc>// Optional amount for partial refunds./span>span classx> /span>span classn>Amount/span>span classo>:/span>span classx> /span>span classs>5.00/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>Refund/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Approved/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>approved/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>RefundRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>RefundRequest/span>span classp>{/span> span classn>TransactionId/span> span classp>/span> span classs><PREVIOUS TRANSACTION ID>/span>span classp>,/span> span classn>Amount/span> span classp>/span> span classs>5.00/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>AuthorizationResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>RefundAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.RefundRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.AuthorizationResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>RefundExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>RefundRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>RefundRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTransactionId/span>span classo>(/span>span classs><PREVIOUS TRANSACTION ID>/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setAmount/span>span classo>(/span>span classs>5.00/span>span classo>);/span> span classc1>// Send the request/span> span classn>AuthorizationResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>refund/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>transactionId/span> span classo>>/span> span classs1><PREVIOUS TRANSACTION ID>/span>span classp>,/span> span classc1>// Optional amount for partial refunds./span> span classs1>amount/span> span classo>>/span> span classs1>5.00/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>refund/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>transactionId: /span>span classs1><PREVIOUS TRANSACTION ID>/span>span classp>,/span> span classc1># Optional amount for partial refunds./span> span classss>amount: /span>span classs1>5.00/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>refund/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>transactionId/span>span classp>:/span> span classs><PREVIOUS TRANSACTION ID>/span>span classp>,/span> span classc># Optional amount for partial refunds./span> span classs>amount/span>span classp>:/span> span classs>5.00/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>refund/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>refund/span>span classp>({/span> span classna>transactionId/span>span classp>:/span> span classs1><PREVIOUS TRANSACTION ID>/span>span classp>,/span> span classc1>// Optional amount for partial refunds./span> span classna>amount/span>span classp>:/span> span classs1>5.00/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>RefundRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>transactionId/span> span classo>/span> span classs1><PREVIOUS TRANSACTION ID>/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>amount/span> span classo>/span> span classs1>5.00/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>refund/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>AuthorizationResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>transactionId/span>span classp>/span> span classo>/span> span classs><PREVIOUS TRANSACTION ID>/span> span classn>request/span>span classp>/span>span classs>amount/span>span classp>/span> span classo>/span> span classs>5.00/span> span classp>/span>span classn>client/span> span classnf>refundWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@approved/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@approved/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>transactionId/span>span classp>/span> span classo>/span> span classs><PREVIOUS TRANSACTION ID>/span> span classn>request/span>span classp>/span>span classs>amount/span>span classp>/span> span classo>/span> span classs>5.00/span> span classn>client/span>span classo>./span>span classnf>refund/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>approved/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>approved/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>refund_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classk>mut/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>RefundRequest/span>span classp>{/span> span classn>transaction_id/span>span classp>:/span> span classs><PREVIOUS TRANSACTION ID>/span>span classnf>.to_string/span>span classp>(),/span> span classn>amount/span>span classp>:/span> span classs>5.00/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.refund/span>span classp>(/span>span classo>&/span>span classk>mut/span> span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.approved/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>approved/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>refund_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>approved/span>span classp>,/span>span classw> /span>span classs2>approved/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>authCode/span>span classp>:/span>span classw> /span>span classs2>778648/span>span classp>,/span>span classw> /span>span classs2>transactionId/span>span classp>:/span>span classw> /span>span classs2>KJ3DPHULBAI6VOTVNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>KJ3DPFELBAI6VOTRNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>refund/span>span classp>,/span>span classw> /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classs2>2020-04-30T20:14:38Z/span>span classp>,/span>span classw> /span>span classs2>tickBlock/span>span classp>:/span>span classw> /span>span classs2>009991a8ac7b6a4420760e1e14e1689c88be2a610a033d6908c1b04b5c00f9da/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>partialAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>altCurrency/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>fsaAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>currencyCode/span>span classp>:/span>span classw> /span>span classs2>USD/span>span classp>,/span>span classw> /span>span classs2>requestedAmount/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>27.00/span>span classp>,/span>span classw> /span>span classs2>remainingBalance/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>tipAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>taxAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>requestedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>authorizedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>CHIP/span>span classp>,/span>span classw> /span>span classs2>paymentType/span>span classp>:/span>span classw> /span>span classs2>VISA/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************0010/span>span classp>,/span>span classw> /span>span classs2>avsResponse/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>receiptSuggestions/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>merchantName/span>span classp>:/span>span classw> /span>span classs2>Test Merchant/span>span classp>,/span>span classw> /span>span classs2>requestSignature/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************0010/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>27.00/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>refund/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>CHIP/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>customer/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>whiteListedCard/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>storeAndForward/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>It's not ideal, but sometimes customers want their money back./p>p>Our refund API allows you to confront this unpleasant reality by executing refunds in a few different scenarios./p>p>The most fraud resistent method is to execute refunds in the context of a previous transaction. You should always keep track of the Transaction IDreturned in a BlockChyp response. To refund the full amount of the previous transaction, just pass in the original Transaction ID with the refund requests./p>p>strong>Partial Refunds/strong>/p>p>For a partial refund, just pass in an amount along with the Transaction ID.The only rule is that the amount must be equal to or less than the originaltransaction. You can execute multiple partial refunds against the sameoriginal transaction as long as the total refunded amount doesn't exceed the original amount./p>p>strong>Tokenized Refunds/strong>/p>p>You can also use a token to execute a refund. Pass in a token insteadof the Transaction ID and the desired refund amount./p>p>strong>Free Range Refunds/strong>/p>p>When you execute a refund without referencing a previous transaction, wecall this a em>free range refund/em>./p>p>We don't recommend this type of refund, but it is permitted. If you absolutely insist ondoing it, pass in a Terminal Name and an amount./p>p>You can execute a manual or keyed refund by passing the code>ManualEntry/code> fieldto a free range refund request./p>p>strong>Gift Card Refunds/strong>/p>p>Gift card refunds are allowed in the context of a previous transaction, butfree range gift card refunds are not allowed. Use the gift card activationAPI if you need to add more funds to a gift card./p>p>strong>Store and Forward Support/strong>/p>p>Refunds are not permitted when a terminal falls back to store and forward mode./p>p>strong>Auto Voids/strong>/p>p>If a refund referencing a previous transaction is executed for the full amountbefore the original transaction's batch is closed, the refund is automaticallyconverted to a void. This saves the merchant a little bit of money./p>p>strong>Cryptocurrency/strong>/p>p>Note that refunds are not supported for cryptocurrency. You must refund crypto transactionsmanually from your cryptocurrency wallet./p>h2 idvoid>Void/h2>blockquote>p>Void Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>void/span> -txspan classo>/span>span classs2><PREAUTH TRANSACTION ID>/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>void/span> -txspan classo>/span>span classs2><PREAUTH TRANSACTION ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>voidExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>VoidRequest/span>span classp>{/span>span classx> /span>span classn>Test/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classn>TransactionID/span>span classo>:/span>span classx> /span>span classs><PREVIOUS TRANSACTION ID>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>Void/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Approved/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>approved/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>VoidRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>VoidRequest/span>span classp>{/span> span classn>Test/span> span classp>/span> span classk>true/span>span classp>,/span> span classn>TransactionId/span> span classp>/span> span classs><PREVIOUS TRANSACTION ID>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>VoidResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>VoidAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.VoidRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.VoidResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>VoidExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>VoidRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>VoidRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTest/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setTransactionId/span>span classo>(/span>span classs><PREVIOUS TRANSACTION ID>/span>span classo>);/span> span classc1>// Send the request/span> span classn>VoidResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>voidTx/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>test/span> span classo>>/span> span classkc>true/span>span classp>,/span> span classs1>transactionId/span> span classo>>/span> span classs1><PREVIOUS TRANSACTION ID>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>void/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>test: /span>span classkp>true/span>span classp>,/span> span classss>transactionId: /span>span classs1><PREVIOUS TRANSACTION ID>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>void/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>test/span>span classp>:/span> span classbp>True/span>span classp>,/span> span classs>transactionId/span>span classp>:/span> span classs><PREVIOUS TRANSACTION ID>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>void/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classk>void/span>span classp>({/span> span classna>test/span>span classp>:/span> span classkc>true/span>span classp>,/span> span classna>transactionId/span>span classp>:/span> span classs1><PREVIOUS TRANSACTION ID>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>VoidRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>test/span> span classo>/span> span classkc>true/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>transactionId/span> span classo>/span> span classs1><PREVIOUS TRANSACTION ID>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classk>void/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>VoidResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classnb>true/span> span classn>request/span>span classp>/span>span classs>transactionId/span>span classp>/span> span classo>/span> span classs><PREVIOUS TRANSACTION ID>/span> span classp>/span>span classn>client/span> span classnf>voidWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@approved/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@approved/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classkc>true/span> span classn>request/span>span classp>/span>span classs>transactionId/span>span classp>/span> span classo>/span> span classs><PREVIOUS TRANSACTION ID>/span> span classn>client/span>span classo>./span>span classnf>void/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>approved/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>approved/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>void_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>VoidRequest/span>span classp>{/span> span classn>test/span>span classp>:/span> span classk>true/span>span classp>,/span> span classn>transaction_id/span>span classp>:/span> span classs><PREVIOUS TRANSACTION ID>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.void/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.approved/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>approved/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>void_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>approved/span>span classp>,/span>span classw> /span>span classs2>approved/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>authCode/span>span classp>:/span>span classw> /span>span classs2>537045/span>span classp>,/span>span classw> /span>span classs2>transactionId/span>span classp>:/span>span classw> /span>span classs2>KJ3DPKELBAI6VOTYNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>KJ3DPFELBAI6VOTRNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>void/span>span classp>,/span>span classw> /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classs2>2020-04-30T21:19:09Z/span>span classp>,/span>span classw> /span>span classs2>tickBlock/span>span classp>:/span>span classw> /span>span classs2>009991a8ac7b6a4420760e1e14e1689c88be2a610a033d6908c1b04b5c00f9da/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>CHIP/span>span classp>,/span>span classw> /span>span classs2>paymentType/span>span classp>:/span>span classw> /span>span classs2>VISA/span>span classp>,/span>span classw> /span>span classs2>avsResponse/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>receiptSuggestions/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>requestSignature/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>customer/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>Mistakes happen. If a transaction is made by mistake, you can void itwith this API. All that's needed is to pass in a Transaction ID and executethe void before the original transaction's batch closes./p>p>Voids work with EBT and gift card transactions with no additional parameters./p>p>strong>Cryptocurrency/strong>/p>p>Note that voids are not supported for cryptocurrency. You must refund crypto transactionsmanually from your cryptocurrency wallet./p>aside classwarning>Transactions can only be voided before the original transactions batch isclosed. If you cancel a transaction after batch closure, youll haveto use a refund instead./aside>h2 idcard-metadata>Card Metadata/h2>blockquote>p>Card Metadata Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>card-metadata/span> -terminalspan classo>/span>span classs2>Test Terminal/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>card-metadata/span> -terminalspan classo>/span>span classs2>Test Terminal/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>cardMetadataExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>CardMetadataRequest/span>span classp>{/span>span classx> /span>span classn>Test/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classn>TerminalName/span>span classo>:/span>span classx> /span>span classs>Test Terminal/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>CardMetadata/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>CardMetadataRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>CardMetadataRequest/span>span classp>{/span> span classn>Test/span> span classp>/span> span classk>true/span>span classp>,/span> span classn>TerminalName/span> span classp>/span> span classs>Test Terminal/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>CardMetadataResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>CardMetadataAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.CardMetadataRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.CardMetadataResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>CardMetadataExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>CardMetadataRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>CardMetadataRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTest/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setTerminalName/span>span classo>(/span>span classs>Test Terminal/span>span classo>);/span> span classc1>// Send the request/span> span classn>CardMetadataResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>cardMetadata/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>test/span> span classo>>/span> span classkc>true/span>span classp>,/span> span classs1>terminalName/span> span classo>>/span> span classs1>Test Terminal/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>cardMetadata/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>test: /span>span classkp>true/span>span classp>,/span> span classss>terminalName: /span>span classs1>Test Terminal/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>cardMetadata/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>test/span>span classp>:/span> span classbp>True/span>span classp>,/span> span classs>terminalName/span>span classp>:/span> span classs>Test Terminal/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>card_metadata/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>cardMetadata/span>span classp>({/span> span classna>test/span>span classp>:/span> span classkc>true/span>span classp>,/span> span classna>terminalName/span>span classp>:/span> span classs1>Test Terminal/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>CardMetadataRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>test/span> span classo>/span> span classkc>true/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>terminalName/span> span classo>/span> span classs1>Test Terminal/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>cardMetadata/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>CardMetadataResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classnb>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classp>/span>span classn>client/span> span classnf>cardMetadataWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classkc>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>client/span>span classo>./span>span classnf>cardMetadata/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>card_metadata_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classk>mut/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>CardMetadataRequest/span>span classp>{/span> span classn>test/span>span classp>:/span> span classk>true/span>span classp>,/span> span classn>terminal_name/span>span classp>:/span> span classs>Test Terminal/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.card_metadata/span>span classp>(/span>span classo>&/span>span classk>mut/span> span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>card_metadata_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>approved/span>span classp>,/span>span classw> /span>span classs2>cardMetadata/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>cardBrand/span>span classp>:/span>span classw> /span>span classs2>MC/span>span classp>,/span>span classw> /span>span classs2>issuerName/span>span classp>:/span>span classw> /span>span classs2>Chase Bank USA/span>span classp>,/span>span classw> /span>span classs2>l3/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>l2/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>productType/span>span classp>:/span>span classw> /span>span classs2>MCC/span>span classp>,/span>span classw> /span>span classs2>productName/span>span classp>:/span>span classw> /span>span classs2>MCC - Chase credit card/span>span classp>,/span>span classw> /span>span classs2>ebt/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>debit/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>healthcare/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>prepaid/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>region/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>country/span>span classp>:/span>span classw> /span>span classs2>USA/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API allows you to retrieve card metadata./p>p>Card metadata requests can use a payment terminal to retrieve metadata oruse a previously enrolled payment token./p>p>strong>Terminal Transactions/strong>/p>p>For terminal transactions, make sure you pass in the terminal name using the code>terminalName/code> property./p>p>strong>Token Transactions/strong>/p>p>If you have a payment token, omit the code>terminalName/code> property and pass in the token with the code>token/code>property instead./p>p>strong>Card Numbers and Mag Stripes/strong>/p>p>You can also pass in PANs and Mag Stripes, but you probably shouldn't, as this willput you in PCI scope and the most common vector for POS breaches is keylogging.If you use terminals for manual card entry, you'll bypass any keyloggers thatmight be maliciously running on the point-of-sale system./p>aside classwarning>Note that if you pass mag stripes or account numbers into a card metadata transaction, you will be in PCI scope. If you need to retrieve card metadata, consider using the terminal with the b>manual/b> flag set for improved security./aside>h2 idtime-out-reversal>Time Out Reversal/h2>blockquote>p>Time Out Reversal Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>reverse/span> -txRefspan classo>/span>span classs2><LAST TRANSACTION REF>/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>reverse/span> -txRefspan classo>/span>span classs2><LAST TRANSACTION REF>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>reverseExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>AuthorizationRequest/span>span classp>{/span>span classx> /span>span classn>TransactionRef/span>span classo>:/span>span classx> /span>span classs><LAST TRANSACTION REF>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>Reverse/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Approved/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>approved/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>AuthorizationRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>AuthorizationRequest/span>span classp>{/span> span classn>TransactionRef/span> span classp>/span> span classs><LAST TRANSACTION REF>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>AuthorizationResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>ReverseAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.AuthorizationRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.AuthorizationResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>ReverseExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>AuthorizationRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>AuthorizationRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTransactionRef/span>span classo>(/span>span classs><LAST TRANSACTION REF>/span>span classo>);/span> span classc1>// Send the request/span> span classn>AuthorizationResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>reverse/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>transactionRef/span> span classo>>/span> span classs1><LAST TRANSACTION REF>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>reverse/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>transactionRef: /span>span classs1><LAST TRANSACTION REF>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>reverse/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>transactionRef/span>span classp>:/span> span classs><LAST TRANSACTION REF>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>reverse/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>reverse/span>span classp>({/span> span classna>transactionRef/span>span classp>:/span> span classs1><LAST TRANSACTION REF>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>AuthorizationRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>transactionRef/span> span classo>/span> span classs1><LAST TRANSACTION REF>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>reverse/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>AuthorizationResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>transactionRef/span>span classp>/span> span classo>/span> span classs><LAST TRANSACTION REF>/span> span classp>/span>span classn>client/span> span classnf>reverseWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@approved/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@approved/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>transactionRef/span>span classp>/span> span classo>/span> span classs><LAST TRANSACTION REF>/span> span classn>client/span>span classo>./span>span classnf>reverse/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>approved/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>approved/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>reverse_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>AuthorizationRequest/span>span classp>{/span> span classn>transaction_ref/span>span classp>:/span> span classs><LAST TRANSACTION REF>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.reverse/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.approved/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>approved/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>reverse_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>approved/span>span classp>,/span>span classw> /span>span classs2>approved/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>authCode/span>span classp>:/span>span classw> /span>span classs2>130621/span>span classp>,/span>span classw> /span>span classs2>transactionId/span>span classp>:/span>span classw> /span>span classs2>KJ3DPMULBAI6VOTZNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>KJ3DPFELBAI6VOTRNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>transactionRef/span>span classp>:/span>span classw> /span>span classs2>YOURTXREF/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>reverse/span>span classp>,/span>span classw> /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classs2>2020-04-30T21:29:38Z/span>span classp>,/span>span classw> /span>span classs2>tickBlock/span>span classp>:/span>span classw> /span>span classs2>009991a8ac7b6a4420760e1e14e1689c88be2a610a033d6908c1b04b5c00f9da/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>partialAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>altCurrency/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>fsaAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>currencyCode/span>span classp>:/span>span classw> /span>span classs2>USD/span>span classp>,/span>span classw> /span>span classs2>requestedAmount/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>remainingBalance/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>tipAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>taxAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>requestedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>authorizedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>CHIP/span>span classp>,/span>span classw> /span>span classs2>paymentType/span>span classp>:/span>span classw> /span>span classs2>VISA/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************0010/span>span classp>,/span>span classw> /span>span classs2>avsResponse/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>receiptSuggestions/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>merchantName/span>span classp>:/span>span classw> /span>span classs2>Test Merchant/span>span classp>,/span>span classw> /span>span classs2>requestSignature/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************0010/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>reverse/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>CHIP/span>span classp>,/span>span classw> /span>span classs2>surcharge/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>cashDiscount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>customer/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>whiteListedCard/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>storeAndForward/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>Payment transactions require a stable network to function correctly andno network is stable all the time. Time out reversals are a great lineof defense against accidentally double charging consumers when paymentsare retried during shaky network conditions./p>p>We highly recommend developers use this API whenever a charge, preauth, or refund transaction times out. If you don't receive a definitive responsefrom BlockChyp, you can't be certain about whether or not the transaction went through./p>p>The best practice in this situation is to send a time out reversal request. Time out reversals check for a transaction and void it if it exists./p>p>The only caveat is that developers must use the code>transactionRef/code> property (code>txRef/code> for the CLI) when executing charge, preauth, and refund transactions./p>p>The reason for this requirement is that if a system never receives a definitiveresponse for a transaction, the system would never have received the BlockChypgenerated Transaction ID. We have to fall back to Transaction Ref to identifya transaction./p>p>strong>Cryptocurrency/strong>/p>p>Note that refunds are not supported for cryptocurrency. You must refund crypto transactionsmanually from your cryptocurrency wallet./p>aside classwarning>A time out reversal must be executed within two minutes of the original transaction./aside>aside classsuccess>b>Reversals Are Your Friend/b>p>We strongly recommend that all developers send time out reversalswhenever they fail to receive a response from the terminal. Thiswill prevent double charges, which are considered harmful./p>/aside>h2 idgift-card-activation>Gift Card Activation/h2>blockquote>p>Gift Card Activation Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>gift-activate/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -amountspan classo>/span>span classs2>50.00/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>gift-activate/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -amountspan classo>/span>span classs2>50.00/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>giftActivateExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>GiftActivateRequest/span>span classp>{/span>span classx> /span>span classn>Test/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classn>TerminalName/span>span classo>:/span>span classx> /span>span classs>Test Terminal/span>span classp>,/span>span classx> /span>span classn>Amount/span>span classo>:/span>span classx> /span>span classs>50.00/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>GiftActivate/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Approved/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>approved/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>GiftActivateRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>GiftActivateRequest/span>span classp>{/span> span classn>Test/span> span classp>/span> span classk>true/span>span classp>,/span> span classn>TerminalName/span> span classp>/span> span classs>Test Terminal/span>span classp>,/span> span classn>Amount/span> span classp>/span> span classs>50.00/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>GiftActivateResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>GiftActivateAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.GiftActivateRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.GiftActivateResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>GiftActivateExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>GiftActivateRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>GiftActivateRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTest/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setTerminalName/span>span classo>(/span>span classs>Test Terminal/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setAmount/span>span classo>(/span>span classs>50.00/span>span classo>);/span> span classc1>// Send the request/span> span classn>GiftActivateResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>giftActivate/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>test/span> span classo>>/span> span classkc>true/span>span classp>,/span> span classs1>terminalName/span> span classo>>/span> span classs1>Test Terminal/span>span classp>,/span> span classs1>amount/span> span classo>>/span> span classs1>50.00/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>giftActivate/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>test: /span>span classkp>true/span>span classp>,/span> span classss>terminalName: /span>span classs1>Test Terminal/span>span classp>,/span> span classss>amount: /span>span classs1>50.00/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>giftActivate/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>test/span>span classp>:/span> span classbp>True/span>span classp>,/span> span classs>terminalName/span>span classp>:/span> span classs>Test Terminal/span>span classp>,/span> span classs>amount/span>span classp>:/span> span classs>50.00/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>gift_activate/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>giftActivate/span>span classp>({/span> span classna>test/span>span classp>:/span> span classkc>true/span>span classp>,/span> span classna>terminalName/span>span classp>:/span> span classs1>Test Terminal/span>span classp>,/span> span classna>amount/span>span classp>:/span> span classs1>50.00/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>GiftActivateRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>test/span> span classo>/span> span classkc>true/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>terminalName/span> span classo>/span> span classs1>Test Terminal/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>amount/span> span classo>/span> span classs1>50.00/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>giftActivate/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>GiftActivateResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classnb>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>request/span>span classp>/span>span classs>amount/span>span classp>/span> span classo>/span> span classs>50.00/span> span classp>/span>span classn>client/span> span classnf>giftActivateWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@approved/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@approved/span>span classp>);/span> span classp>}/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@amount/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@amount/span>span classp>)/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@currentBalance/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@currentBalance/span>span classp>)/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@publicKey/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@publicKey/span>span classp>)/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classkc>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>request/span>span classp>/span>span classs>amount/span>span classp>/span> span classo>/span> span classs>50.00/span> span classn>client/span>span classo>./span>span classnf>giftActivate/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>approved/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>approved/span>span classp>)/span> span classp>}/span> span classkt>NSLog/span>span classp>(/span>span classs>amount/span> span classo>+/span> span classs>: /span> span classo>+/span> span classp>(/span>span classn>response/span>span classp>/span>span classs>amount/span>span classp>/span> span classk>as?/span> span classkt>String/span>span classp>)/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classkt>NSLog/span>span classp>(/span>span classs>currentBalance/span> span classo>+/span> span classs>: /span> span classo>+/span> span classp>(/span>span classn>response/span>span classp>/span>span classs>currentBalance/span>span classp>/span> span classk>as?/span> span classkt>String/span>span classp>)/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classkt>NSLog/span>span classp>(/span>span classs>publicKey/span> span classo>+/span> span classs>: /span> span classo>+/span> span classp>(/span>span classn>response/span>span classp>/span>span classs>publicKey/span>span classp>/span> span classk>as?/span> span classkt>String/span>span classp>)/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>gift_activate_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classk>mut/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>GiftActivateRequest/span>span classp>{/span> span classn>test/span>span classp>:/span> span classk>true/span>span classp>,/span> span classn>terminal_name/span>span classp>:/span> span classs>Test Terminal/span>span classnf>.to_string/span>span classp>(),/span> span classn>amount/span>span classp>:/span> span classs>50.00/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.gift_activate/span>span classp>(/span>span classo>&/span>span classk>mut/span> span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.approved/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>approved/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>gift_activate_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>APPROVED/span>span classp>,/span>span classw> /span>span classs2>transactionId/span>span classp>:/span>span classw> /span>span classs2>KJ3DPPELBAI6VOT4NSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>gift_activate/span>span classp>,/span>span classw> /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classs2>2020-04-30T22:41:23Z/span>span classp>,/span>span classw> /span>span classs2>tickBlock/span>span classp>:/span>span classw> /span>span classs2>000966828e6b196be72a480bf3a70e77c685262b6a4249b560ef770c8fb51eac/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>approved/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>amount/span>span classp>:/span>span classw> /span>span classs2>50.00/span>span classp>,/span>span classw> /span>span classs2>currentBalance/span>span classp>:/span>span classw> /span>span classs2>50.00/span>span classp>,/span>span classw> /span>span classs2>currencyCode/span>span classp>:/span>span classw> /span>span classs2>USD/span>span classp>,/span>span classw> /span>span classs2>publicKey/span>span classp>:/span>span classw> /span>span classs2>13TwUmBCg286Lw8N6EA3QgNu9LRerfhDcHwWKVSLnuNw9etWWfr/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************3904/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API activates or adds value to BlockChyp gift cards.Just pass in the terminal name and the amount to add to the card.Once the customer swipes their card, the terminal will use keyson the mag stripe to add value to the card./p>p>You don't need to handle a new gift card activation or a gift card recharge anydifferently. The terminal firmware will figure out what to do on itsown while also returning the new balance for the gift card./p>p>This is the part of the system where BlockChyp's blockchain DNA comesclosest to the surface. The BlockChyp gift card system doesn't reallyuse gift card numbers. This means they can't be stolen./p>p>BlockChyp identifies cards with an elliptic curve public key instead.Gift card transactions are actually blocks signed with those keys.This means there are no shared secrets sent over the network.To keep track of a BlockChyp gift card, hang on to the strong>public key/strong> returnedduring gift card activation. That's the gift card's elliptic curve public key./p>p>We sometimes print numbers on our gift cards, but these are actuallydecimal encoded hashes of a portion of the public key to make our giftcards seem em>normal/em> to em>normies/em>. They can be usedfor balance checks and play a lookup role in online gift cardauthorization, but are of little use beyond that./p>p>strong>Voids and Reversals/strong>/p>p>Gift card activations can be voided and reversed just like any otherBlockChyp transaction. Use the Transaction ID or Transaction Refto identify the gift activation transaction as you normally would forvoiding or reversing a conventional payment transaction./p>p>strong>Importing Gift Cards/strong>/p>p>BlockChyp does have the ability to import gift card liability fromconventional gift card platforms. Unfortunately, BlockChyp does notsupport activating cards on third party systems. However, you can importyour outstanding gift cards and customers can swipe them on theterminals like BlockChyp's standard gift cards./p>p>No special coding is required to access this feature. The gateway andterminal firmware handle everything for you./p>p>strong>Third Party Gift Card Networks/strong>/p>p>BlockChyp does not currently provide any native support for other gift cardplatforms beyond importing gift card liability. We do have a white listing systemthat can be used to support your own custom gift card implementations. We have a security reviewprocess before we can allow a BIN range to be white listed, so contactsupport@blockchyp.com if you need to white list a BIN range./p>aside classinfo>b>Whats the tick block for?/b>p>This is another artifact from our internal blockchain and its returnedwith almost every transaction. Its a hash of themost recent block on the BlockChyp Clock Chain at the time the transactionwas executed. Its effectively b>blockchain time/b>./p>p>Since all blockchains arebased on a paranoid-trust-nobody ethos, the consensus and validation algorithmsfor most blockchains, including ours, never trust an externally reportedtimestamp. The tick block is a tamper and fraud proof indication of thetransactions relative execution time./p>p>We use tick blocks for some things internally, but you can just ignore itif you want./p>/aside>h2 idbalance>Balance/h2>blockquote>p>Balance Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>balance/span> -terminalspan classo>/span>span classs2>Test Terminal/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>balance/span> -terminalspan classo>/span>span classs2>Test Terminal/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>balanceExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>BalanceRequest/span>span classp>{/span>span classx> /span>span classn>Test/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classn>TerminalName/span>span classo>:/span>span classx> /span>span classs>Test Terminal/span>span classp>,/span>span classx> /span>span classn>CardType/span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>CardTypeEBT/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>Balance/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>BalanceRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>BalanceRequest/span>span classp>{/span> span classn>Test/span> span classp>/span> span classk>true/span>span classp>,/span> span classn>TerminalName/span> span classp>/span> span classs>Test Terminal/span>span classp>,/span> span classn>CardType/span> span classp>/span> span classn>CardType/span>span classp>./span>span classn>EBT/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>BalanceResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>BalanceAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.BalanceRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.BalanceResponse/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.CardType/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>BalanceExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>BalanceRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>BalanceRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTest/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setTerminalName/span>span classo>(/span>span classs>Test Terminal/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setCardType/span>span classo>(/span>span classn>CardType/span>span classo>./span>span classna>EBT/span>span classo>);/span> span classc1>// Send the request/span> span classn>BalanceResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>balance/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>test/span> span classo>>/span> span classkc>true/span>span classp>,/span> span classs1>terminalName/span> span classo>>/span> span classs1>Test Terminal/span>span classp>,/span> span classs1>cardType/span> span classo>>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>CARD_TYPE_EBT/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>balance/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>test: /span>span classkp>true/span>span classp>,/span> span classss>terminalName: /span>span classs1>Test Terminal/span>span classp>,/span> span classss>cardType: /span>span classno>CardType/span>span classo>::/span>span classno>EBT/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>balance/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>test/span>span classp>:/span> span classbp>True/span>span classp>,/span> span classs>terminalName/span>span classp>:/span> span classs>Test Terminal/span>span classp>,/span> span classs>cardType/span>span classp>:/span> span classn>blockchyp/span>span classo>./span>span classn>CardType/span>span classo>./span>span classn>EBT/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>balance/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>balance/span>span classp>({/span> span classna>test/span>span classp>:/span> span classkc>true/span>span classp>,/span> span classna>terminalName/span>span classp>:/span> span classs1>Test Terminal/span>span classp>,/span> span classna>cardType/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>CardType/span>span classp>./span>span classnx>EBT/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>BalanceRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>test/span> span classo>/span> span classkc>true/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>terminalName/span> span classo>/span> span classs1>Test Terminal/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>cardType/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>CardType/span>span classp>./span>span classnx>EBT/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>balance/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>BalanceResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classnb>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>request/span>span classp>/span>span classs>cardType/span>span classp>/span> span classo>/span> span classp>/span>span classn>NSNumber/span> span classnf>numberWithInt/span>span classp>:/span>span classn>CARD_TYPE_EBT/span>span classp>/span> span classp>/span>span classn>client/span> span classnf>balanceWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classkc>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>request/span>span classp>/span>span classs>cardType/span>span classp>/span> span classo>/span> span classp>/span>span classkt>NSNumber/span> span classnv>numberWithInt/span>span classp>:/span>span classkt>CARD_TYPE_EBT/span>span classp>/span> span classn>client/span>span classo>./span>span classnf>balance/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>balance_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classk>mut/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>BalanceRequest/span>span classp>{/span> span classn>test/span>span classp>:/span> span classk>true/span>span classp>,/span> span classn>terminal_name/span>span classp>:/span> span classs>Test Terminal/span>span classnf>.to_string/span>span classp>(),/span> span classn>card_type/span>span classp>:/span> span classnn>blockchyp/span>span classp>::/span>span classnn>CardType/span>span classp>::/span>span classn>EBT/span>span classp>,/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.balance/span>span classp>(/span>span classo>&/span>span classk>mut/span> span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>balance_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionId/span>span classp>:/span>span classw> /span>span classs2>KJ3DPMULBAI6VOT3NSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>balance/span>span classp>,/span>span classw> /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>tickBlock/span>span classp>:/span>span classw> /span>span classs2>0006bea9b77d4452be3e7979eaedd357d0da22cc0d1a85f6027176a2f00d0bea/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>paymentType/span>span classp>:/span>span classw> /span>span classs2>BC_GIFT/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************3904/span>span classp>,/span>span classw> /span>span classs2>publicKey/span>span classp>:/span>span classw> /span>span classs2>13TwUmBCg286Lw8N6EA3QgNu9LRerfhDcHwWKVSLnuNw9etWWfr/span>span classp>,/span>span classw> /span>span classs2>avsResponse/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>receiptSuggestions/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>merchantName/span>span classp>:/span>span classw> /span>span classs2>Test Merchant/span>span classp>,/span>span classw> /span>span classs2>requestSignature/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************3904/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>balance/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>SWIPE/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>customer/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>remainingBalance/span>span classp>:/span>span classw> /span>span classs2>50.00/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API checks a gift or EBT card balance./p>p>strong>Gift Card Balance Checks/strong>/p>p>For gift cards, pass in a terminal name and the customer will be promptedto swipe a card on that terminal. The remaining balance will be displayedbriefly on the terminal screen and the API response will include the gift card's public key and the remaining balance./p>p>strong>EBT Balance Checks/strong>/p>p>All EBT transactions require a PIN, so to check an EBT card balance,you need to pass in the code>ebt/code> flag just like you would for a normal EBTcharge transaction. The customer will be prompted to swipe their card andenter a PIN code. If everything checks out, the remaining balance on the card will be displayed on the terminal for the customer and returned with the API response./p>p>strong>Testing Gift Card Balance Checks/strong>/p>p>Test gift card balance checks work no differently than live gift cards. Youmust activate a test gift card first to test balance checks. Testgift cards are real blockchain cards that live on our parallel test blockchain./p>p>strong>Testing EBT Gift Card Balance Checks/strong>/p>p>All test EBT transactions assume a starting balance of $100.00. As a result,test EBT balance checks always return a balance of $100.00./p>h2 idclose-batch>Close Batch/h2>blockquote>p>Close Batch Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>close-batch/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>close-batch/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>closeBatchExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>CloseBatchRequest/span>span classp>{/span>span classx> /span>span classn>Test/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>CloseBatch/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>CloseBatchRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>CloseBatchRequest/span>span classp>{/span> span classn>Test/span> span classp>/span> span classk>true/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>CloseBatchResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>CloseBatchAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.CloseBatchRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.CloseBatchResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>CloseBatchExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>CloseBatchRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>CloseBatchRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTest/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classc1>// Send the request/span> span classn>CloseBatchResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>closeBatch/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>test/span> span classo>>/span> span classkc>true/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>closeBatch/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>test: /span>span classkp>true/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>closeBatch/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>test/span>span classp>:/span> span classbp>True/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>close_batch/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>closeBatch/span>span classp>({/span> span classna>test/span>span classp>:/span> span classkc>true/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>CloseBatchRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>test/span> span classo>/span> span classkc>true/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>closeBatch/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>CloseBatchResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classnb>true/span> span classp>/span>span classn>client/span> span classnf>closeBatchWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classkc>true/span> span classn>client/span>span classo>./span>span classnf>closeBatch/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>close_batch_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>CloseBatchRequest/span>span classp>{/span> span classn>test/span>span classp>:/span> span classk>true/span>span classp>,/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.close_batch/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>close_batch_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>KJ3DPFELBAI6VOTRNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>tickBlock/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>currencyCode/span>span classp>:/span>span classw> /span>span classs2>USD/span>span classp>,/span>span classw> /span>span classs2>capturedTotal/span>span classp>:/span>span classw> /span>span classs2>55.00/span>span classp>,/span>span classw> /span>span classs2>openPreauths/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API will close the merchant's batch if it's currently open./p>p>By default, merchant batches will close automatically at 3 AM in theirlocal time zone. The automatic batch closure time can be changedin the Merchant Profile or disabled completely./p>p>If automatic batch closure is disabled, you'll need to use this API toclose the batch manually./p>aside classsuccess>b>What if I leave a batch open?/b>p>Weve got your back. We have internal monitoring that ensures no batch isleft open for more than 24 hours. If you forget to close a batch, ouroperations team will probably close it for you./p>/aside>h2 idsend-payment-link>Send Payment Link/h2>blockquote>p>Send Payment Link Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>send-link/span> -displaySubtotalspan classo>/span>span classs2>327.00/span> -displayTaxspan classo>/span>span classs2>16.35/span> -displayTotalspan classo>/span>span classs2>353.35/span> -lineItemIdspan classo>/span>span classs2>1|2|3/span> -lineItemDescriptionspan classo>/span>span classs2>Hiking Boots|Camping Tent|Backpack/span> -lineItemQtyspan classo>/span>span classs2>1|2|1/span> -lineItemPricespan classo>/span>span classs2>120.00|160.00|70.00/span> -lineItemDiscountDescriptionspan classo>/span>span classs2>Member Discount|Member Discount|Member Discount/span> -lineItemDiscountAmountspan classo>/span>span classs2>10.00|5.00|8.00/span> -lineItemExtendedspan classo>/span>span classs2>110.00|155.00|62.00/span> -descspan classo>/span>span classs2>Thank you for your order. Your order will be ready in 20 minutes/span> -emailspan classo>/span>span classs2>pgregory@raviga.com/span> -firstNamespan classo>/span>span classs2>Peter/span> -lastNamespan classo>/span>span classs2>Gregory/span> -amountspan classo>/span>span classs2>353.35/span> -orderRefspan classo>/span>span classs2>12345/span> -txRefspan classo>/span>span classs2><TX REF>/span> -autoSendWindows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>send-link/span> -displaySubtotalspan classo>/span>span classs2>327.00/span> -displayTaxspan classo>/span>span classs2>16.35/span> -displayTotalspan classo>/span>span classs2>353.35/span> -lineItemIdspan classo>/span>span classs2>1|2|3/span> -lineItemDescriptionspan classo>/span>span classs2>Hiking Boots|Camping Tent|Backpack/span> -lineItemQtyspan classo>/span>span classs2>1|2|1/span> -lineItemPricespan classo>/span>span classs2>120.00|160.00|70.00/span> -lineItemDiscountDescriptionspan classo>/span>span classs2>Member Discount|Member Discount|Member Discount/span> -lineItemDiscountAmountspan classo>/span>span classs2>10.00|5.00|8.00/span> -lineItemExtendedspan classo>/span>span classs2>110.00|155.00|62.00/span> -descspan classo>/span>span classs2>Thank you for your order. Your order will be ready in 20 minutes/span> -emailspan classo>/span>span classs2>pgregory@raviga.com/span> -firstNamespan classo>/span>span classs2>Peter/span> -lastNamespan classo>/span>span classs2>Gregory/span> -amountspan classo>/span>span classs2>353.35/span> -orderRefspan classo>/span>span classs2>12345/span> -txRefspan classo>/span>span classs2><TX REF>/span> -autoSend/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>sendPaymentLinkExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>PaymentLinkRequest/span>span classp>{/span>span classx> /span>span classn>TransactionRef/span>span classo>:/span>span classx> /span>span classs><TX REF>/span>span classp>,/span>span classx> /span>span classn>Amount/span>span classo>:/span>span classx> /span>span classs>199.99/span>span classp>,/span>span classx> /span>span classn>Description/span>span classo>:/span>span classx> /span>span classs>Widget/span>span classp>,/span>span classx> /span>span classn>Subject/span>span classo>:/span>span classx> /span>span classs>Widget invoice/span>span classp>,/span>span classx> /span>span classn>Transaction/span>span classo>:/span>span classx> /span>span classo>&/span>span classn>blockchyp/span>span classo>./span>span classn>TransactionDisplayTransaction/span>span classp>{/span>span classx> /span>span classn>Subtotal/span>span classo>:/span>span classx> /span>span classs>195.00/span>span classp>,/span>span classx> /span>span classn>Tax/span>span classo>:/span>span classx> /span>span classs>4.99/span>span classp>,/span>span classx> /span>span classn>Total/span>span classo>:/span>span classx> /span>span classs>199.99/span>span classp>,/span>span classx> /span>span classn>Items/span>span classo>:/span>span classx> /span>span classp>/span>span classo>*/span>span classn>blockchyp/span>span classo>./span>span classn>TransactionDisplayItem/span>span classp>{/span>span classx> /span>span classo>&/span>span classn>blockchyp/span>span classo>./span>span classn>TransactionDisplayItem/span>span classp>{/span>span classx> /span>span classn>Description/span>span classo>:/span>span classx> /span>span classs>Widget/span>span classp>,/span>span classx> /span>span classn>Price/span>span classo>:/span>span classx> /span>span classs>195.00/span>span classp>,/span>span classx> /span>span classn>Quantity/span>span classo>:/span>span classx> /span>span classm>1/span>span classp>,/span>span classx> /span>span classp>},/span>span classx> /span>span classp>},/span>span classx> /span>span classp>},/span>span classx> /span>span classn>AutoSend/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classn>Customer/span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>Customer/span>span classp>{/span>span classx> /span>span classn>CustomerRef/span>span classo>:/span>span classx> /span>span classs>Customer reference string/span>span classp>,/span>span classx> /span>span classn>FirstName/span>span classo>:/span>span classx> /span>span classs>FirstName/span>span classp>,/span>span classx> /span>span classn>LastName/span>span classo>:/span>span classx> /span>span classs>LastName/span>span classp>,/span>span classx> /span>span classn>CompanyName/span>span classo>:/span>span classx> /span>span classs>Company Name/span>span classp>,/span>span classx> /span>span classn>EmailAddress/span>span classo>:/span>span classx> /span>span classs>notifications@blockchypteam.m8r.co/span>span classp>,/span>span classx> /span>span classn>SmsNumber/span>span classo>:/span>span classx> /span>span classs>(123) 123-1231/span>span classp>,/span>span classx> /span>span classp>},/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>SendPaymentLink/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>PaymentLinkRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>PaymentLinkRequest/span>span classp>{/span> span classn>TransactionRef/span> span classp>/span> span classs><TX REF>/span>span classp>,/span> span classn>Amount/span> span classp>/span> span classs>199.99/span>span classp>,/span> span classn>Description/span> span classp>/span> span classs>Widget/span>span classp>,/span> span classn>Subject/span> span classp>/span> span classs>Widget invoice/span>span classp>,/span> span classn>Transaction/span> span classp>/span> span classk>new/span> span classn>TransactionDisplayTransaction/span> span classp>{/span> span classn>Subtotal/span> span classp>/span> span classs>195.00/span>span classp>,/span> span classn>Tax/span> span classp>/span> span classs>4.99/span>span classp>,/span> span classn>Total/span> span classp>/span> span classs>199.99/span>span classp>,/span> span classn>Items/span> span classp>/span> span classk>new/span> span classn>List/span>span classp>span classn>TransactionDisplayItem/span>span classp>>/span> span classp>{/span> span classk>new/span> span classn>TransactionDisplayItem/span> span classp>{/span> span classn>Description/span> span classp>/span> span classs>Widget/span>span classp>,/span> span classn>Price/span> span classp>/span> span classs>195.00/span>span classp>,/span> span classn>Quantity/span> span classp>/span> span classm>1/span>span classp>,/span> span classp>}/span> span classp>},/span> span classp>},/span> span classn>AutoSend/span> span classp>/span> span classk>true/span>span classp>,/span> span classn>Customer/span> span classp>/span> span classk>new/span> span classn>Customer/span> span classp>{/span> span classn>CustomerRef/span> span classp>/span> span classs>Customer reference string/span>span classp>,/span> span classn>FirstName/span> span classp>/span> span classs>FirstName/span>span classp>,/span> span classn>LastName/span> span classp>/span> span classs>LastName/span>span classp>,/span> span classn>CompanyName/span> span classp>/span> span classs>Company Name/span>span classp>,/span> span classn>EmailAddress/span> span classp>/span> span classs>notifications@blockchypteam.m8r.co/span>span classp>,/span> span classn>SmsNumber/span> span classp>/span> span classs>(123) 123-1231/span>span classp>,/span> span classp>},/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>PaymentLinkResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>SendPaymentLinkAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.PaymentLinkRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.PaymentLinkResponse/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TransactionDisplayTransaction/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TransactionDisplayItem/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.Customer/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>SendPaymentLinkExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>PaymentLinkRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>PaymentLinkRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTransactionRef/span>span classo>(/span>span classs><TX REF>/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setAmount/span>span classo>(/span>span classs>199.99/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setDescription/span>span classo>(/span>span classs>Widget/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setSubject/span>span classo>(/span>span classs>Widget invoice/span>span classo>);/span> span classn>TransactionDisplayTransaction/span> span classn>transaction/span> span classo>/span> span classk>new/span> span classn>TransactionDisplayTransaction/span>span classo>();/span> span classn>transaction/span>span classo>./span>span classna>setSubtotal/span>span classo>(/span>span classs>195.00/span>span classo>);/span> span classn>transaction/span>span classo>./span>span classna>setTax/span>span classo>(/span>span classs>4.99/span>span classo>);/span> span classn>transaction/span>span classo>./span>span classna>setTotal/span>span classo>(/span>span classs>199.99/span>span classo>);/span> span classn>Collection/span> span classn>items/span> span classo>/span> span classk>new/span> span classn>ArrayList/span>span classo>();/span> span classn>TransactionDisplayItem/span> span classn>items0/span> span classo>/span> span classk>new/span> span classn>TransactionDisplayItem/span>span classo>();/span> span classn>items0/span>span classo>./span>span classna>setDescription/span>span classo>(/span>span classs>Widget/span>span classo>);/span> span classn>items0/span>span classo>./span>span classna>setPrice/span>span classo>(/span>span classs>195.00/span>span classo>);/span> span classn>items0/span>span classo>./span>span classna>setQuantity/span>span classo>(/span>span classmi>1/span>span classo>);/span> span classn>items/span>span classo>./span>span classna>add/span>span classo>(/span>span classn>items0/span>span classo>);/span> span classn>transaction/span>span classo>./span>span classna>setItems/span>span classo>(/span>span classn>items/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setTransaction/span>span classo>(/span>span classn>transaction/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setAutoSend/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classn>Customer/span> span classn>customer/span> span classo>/span> span classk>new/span> span classn>Customer/span>span classo>();/span> span classn>customer/span>span classo>./span>span classna>setCustomerRef/span>span classo>(/span>span classs>Customer reference string/span>span classo>);/span> span classn>customer/span>span classo>./span>span classna>setFirstName/span>span classo>(/span>span classs>FirstName/span>span classo>);/span> span classn>customer/span>span classo>./span>span classna>setLastName/span>span classo>(/span>span classs>LastName/span>span classo>);/span> span classn>customer/span>span classo>./span>span classna>setCompanyName/span>span classo>(/span>span classs>Company Name/span>span classo>);/span> span classn>customer/span>span classo>./span>span classna>setEmailAddress/span>span classo>(/span>span classs>notifications@blockchypteam.m8r.co/span>span classo>);/span> span classn>customer/span>span classo>./span>span classna>setSmsNumber/span>span classo>(/span>span classs>(123) 123-1231/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setCustomer/span>span classo>(/span>span classn>customer/span>span classo>);/span> span classc1>// Send the request/span> span classn>PaymentLinkResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>sendPaymentLink/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>transactionRef/span> span classo>>/span> span classs1><TX REF>/span>span classp>,/span> span classs1>amount/span> span classo>>/span> span classs1>199.99/span>span classp>,/span> span classs1>description/span> span classo>>/span> span classs1>Widget/span>span classp>,/span> span classs1>subject/span> span classo>>/span> span classs1>Widget invoice/span>span classp>,/span> span classs1>transaction/span> span classo>>/span> span classp>/span> span classs1>subtotal/span> span classo>>/span> span classs1>195.00/span>span classp>,/span> span classs1>tax/span> span classo>>/span> span classs1>4.99/span>span classp>,/span> span classs1>total/span> span classo>>/span> span classs1>199.99/span>span classp>,/span> span classs1>items/span> span classo>>/span> span classp>/span> span classp>/span> span classs1>description/span> span classo>>/span> span classs1>Widget/span>span classp>,/span> span classs1>price/span> span classo>>/span> span classs1>195.00/span>span classp>,/span> span classs1>quantity/span> span classo>>/span> span classmi>1/span>span classp>,/span> span classp>,/span> span classp>,/span> span classp>,/span> span classs1>autoSend/span> span classo>>/span> span classkc>true/span>span classp>,/span> span classs1>customer/span> span classo>>/span> span classp>/span> span classs1>customerRef/span> span classo>>/span> span classs1>Customer reference string/span>span classp>,/span> span classs1>firstName/span> span classo>>/span> span classs1>FirstName/span>span classp>,/span> span classs1>lastName/span> span classo>>/span> span classs1>LastName/span>span classp>,/span> span classs1>companyName/span> span classo>>/span> span classs1>Company Name/span>span classp>,/span> span classs1>emailAddress/span> span classo>>/span> span classs1>notifications@blockchypteam.m8r.co/span>span classp>,/span> span classs1>smsNumber/span> span classo>>/span> span classs1>(123) 123-1231/span>span classp>,/span> span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>sendPaymentLink/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>transactionRef: /span>span classs1><TX REF>/span>span classp>,/span> span classss>amount: /span>span classs1>199.99/span>span classp>,/span> span classss>description: /span>span classs1>Widget/span>span classp>,/span> span classss>subject: /span>span classs1>Widget invoice/span>span classp>,/span> span classss>transaction: /span>span classp>{/span> span classss>subtotal: /span>span classs1>195.00/span>span classp>,/span> span classss>tax: /span>span classs1>4.99/span>span classp>,/span> span classss>total: /span>span classs1>199.99/span>span classp>,/span> span classss>items: /span>span classp>/span> span classp>{/span> span classss>description: /span>span classs1>Widget/span>span classp>,/span> span classss>price: /span>span classs1>195.00/span>span classp>,/span> span classss>quantity: /span>span classmi>1/span> span classp>}/span> span classp>/span> span classp>},/span> span classss>autoSend: /span>span classkp>true/span>span classp>,/span> span classss>customer: /span>span classp>{/span> span classss>customerRef: /span>span classs1>Customer reference string/span>span classp>,/span> span classss>firstName: /span>span classs1>FirstName/span>span classp>,/span> span classss>lastName: /span>span classs1>LastName/span>span classp>,/span> span classss>companyName: /span>span classs1>Company Name/span>span classp>,/span> span classss>emailAddress: /span>span classs1>notifications@blockchypteam.m8r.co/span>span classp>,/span> span classss>smsNumber: /span>span classs1>(123) 123-1231/span> span classp>}/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>sendPaymentLink/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>transactionRef/span>span classp>:/span> span classs><TX REF>/span>span classp>,/span> span classs>amount/span>span classp>:/span> span classs>199.99/span>span classp>,/span> span classs>description/span>span classp>:/span> span classs>Widget/span>span classp>,/span> span classs>subject/span>span classp>:/span> span classs>Widget invoice/span>span classp>,/span> span classs>transaction/span>span classp>:/span> span classp>{/span> span classs>subtotal/span>span classp>:/span> span classs>195.00/span>span classp>,/span> span classs>tax/span>span classp>:/span> span classs>4.99/span>span classp>,/span> span classs>total/span>span classp>:/span> span classs>199.99/span>span classp>,/span> span classs>items/span>span classp>:/span> span classp>/span> span classp>{/span> span classs>description/span>span classp>:/span> span classs>Widget/span>span classp>,/span> span classs>price/span>span classp>:/span> span classs>195.00/span>span classp>,/span> span classs>quantity/span>span classp>:/span> span classmi>1/span>span classp>,/span> span classp>},/span> span classp>,/span> span classp>},/span> span classs>autoSend/span>span classp>:/span> span classbp>True/span>span classp>,/span> span classs>customer/span>span classp>:/span> span classp>{/span> span classs>customerRef/span>span classp>:/span> span classs>Customer reference string/span>span classp>,/span> span classs>firstName/span>span classp>:/span> span classs>FirstName/span>span classp>,/span> span classs>lastName/span>span classp>:/span> span classs>LastName/span>span classp>,/span> span classs>companyName/span>span classp>:/span> span classs>Company Name/span>span classp>,/span> span classs>emailAddress/span>span classp>:/span> span classs>notifications@blockchypteam.m8r.co/span>span classp>,/span> span classs>smsNumber/span>span classp>:/span> span classs>(123) 123-1231/span>span classp>,/span> span classp>},/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>send_payment_link/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>sendPaymentLink/span>span classp>({/span> span classna>transactionRef/span>span classp>:/span> span classs1><TX REF>/span>span classp>,/span> span classna>amount/span>span classp>:/span> span classs1>199.99/span>span classp>,/span> span classna>description/span>span classp>:/span> span classs1>Widget/span>span classp>,/span> span classna>subject/span>span classp>:/span> span classs1>Widget invoice/span>span classp>,/span> span classna>transaction/span>span classp>:/span> span classp>{/span> span classna>subtotal/span>span classp>:/span> span classs1>195.00/span>span classp>,/span> span classna>tax/span>span classp>:/span> span classs1>4.99/span>span classp>,/span> span classna>total/span>span classp>:/span> span classs1>199.99/span>span classp>,/span> span classna>items/span>span classp>:/span> span classp>/span> span classp>{/span> span classna>description/span>span classp>:/span> span classs1>Widget/span>span classp>,/span> span classna>price/span>span classp>:/span> span classs1>195.00/span>span classp>,/span> span classna>quantity/span>span classp>:/span> span classmi>1/span>span classp>,/span> span classp>},/span> span classp>,/span> span classp>},/span> span classna>autoSend/span>span classp>:/span> span classkc>true/span>span classp>,/span> span classna>customer/span>span classp>:/span> span classp>{/span> span classna>customerRef/span>span classp>:/span> span classs1>Customer reference string/span>span classp>,/span> span classna>firstName/span>span classp>:/span> span classs1>FirstName/span>span classp>,/span> span classna>lastName/span>span classp>:/span> span classs1>LastName/span>span classp>,/span> span classna>companyName/span>span classp>:/span> span classs1>Company Name/span>span classp>,/span> span classna>emailAddress/span>span classp>:/span> span classs1>notifications@blockchypteam.m8r.co/span>span classp>,/span> span classna>smsNumber/span>span classp>:/span> span classs1>(123) 123-1231/span>span classp>,/span> span classp>},/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>PaymentLinkRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>transactionRef/span> span classo>/span> span classs1><TX REF>/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>amount/span> span classo>/span> span classs1>199.99/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>description/span> span classo>/span> span classs1>Widget/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>subject/span> span classo>/span> span classs1>Widget invoice/span>span classp>;/span>span classkd>const/span> span classnx>transaction/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TransactionDisplayTransaction/span>span classp>();/span>span classnx>transaction/span>span classp>./span>span classnx>subtotal/span> span classo>/span> span classs1>195.00/span>span classp>;/span>span classnx>transaction/span>span classp>./span>span classnx>tax/span> span classo>/span> span classs1>4.99/span>span classp>;/span>span classnx>transaction/span>span classp>./span>span classnx>total/span> span classo>/span> span classs1>199.99/span>span classp>;/span>span classkd>const/span> span classnx>items/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TransactionDisplayItem/span>span classp>();/span>span classnx>items/span>span classp>./span>span classnx>description/span> span classo>/span> span classs1>Widget/span>span classp>;/span>span classnx>items/span>span classp>./span>span classnx>price/span> span classo>/span> span classs1>195.00/span>span classp>;/span>span classnx>items/span>span classp>./span>span classnx>quantity/span> span classo>/span> span classmi>1/span>span classp>;/span>span classnx>transaction/span>span classp>./span>span classnx>items/span> span classo>/span> span classp>/span>span classnx>items/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>transaction/span> span classo>/span> span classnx>transaction/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>autoSend/span> span classo>/span> span classkc>true/span>span classp>;/span>span classkd>const/span> span classnx>customer/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>Customer/span>span classp>();/span>span classnx>customer/span>span classp>./span>span classnx>customerRef/span> span classo>/span> span classs1>Customer reference string/span>span classp>;/span>span classnx>customer/span>span classp>./span>span classnx>firstName/span> span classo>/span> span classs1>FirstName/span>span classp>;/span>span classnx>customer/span>span classp>./span>span classnx>lastName/span> span classo>/span> span classs1>LastName/span>span classp>;/span>span classnx>customer/span>span classp>./span>span classnx>companyName/span> span classo>/span> span classs1>Company Name/span>span classp>;/span>span classnx>customer/span>span classp>./span>span classnx>emailAddress/span> span classo>/span> span classs1>notifications@blockchypteam.m8r.co/span>span classp>;/span>span classnx>customer/span>span classp>./span>span classnx>smsNumber/span> span classo>/span> span classs1>(123) 123-1231/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>customer/span> span classo>/span> span classnx>customer/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>sendPaymentLink/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>PaymentLinkResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>transactionRef/span>span classp>/span> span classo>/span> span classs><TX REF>/span> span classn>request/span>span classp>/span>span classs>amount/span>span classp>/span> span classo>/span> span classs>199.99/span> span classn>request/span>span classp>/span>span classs>description/span>span classp>/span> span classo>/span> span classs>Widget/span> span classn>request/span>span classp>/span>span classs>subject/span>span classp>/span> span classo>/span> span classs>Widget invoice/span> span classn>var/span> span classn>transaction/span>span classo>:/span> span classp>/span>span classnf>String/span>span classp>:/span>span classn>Any/span>span classp>/span> span classo>/span> span classp>/span>span classo>:/span>span classp>/span> span classn>transaction/span>span classp>/span>span classs>subtotal/span>span classp>/span> span classo>/span> span classs>195.00/span> span classn>transaction/span>span classp>/span>span classs>tax/span>span classp>/span> span classo>/span> span classs>4.99/span> span classn>transaction/span>span classp>/span>span classs>total/span>span classp>/span> span classo>/span> span classs>199.99/span> span classn>var/span> span classn>items/span> span classo>/span> span classp>/span>span classnf>Any/span>span classp>();/span> span classn>var/span> span classn>items1/span>span classo>:/span> span classp>/span>span classnf>String/span>span classp>:/span>span classn>Any/span>span classp>/span> span classo>/span> span classp>/span>span classo>:/span>span classp>/span> span classn>items1/span>span classp>/span>span classs>description/span>span classp>/span> span classo>/span> span classs>Widget/span> span classn>items1/span>span classp>/span>span classs>price/span>span classp>/span> span classo>/span> span classs>195.00/span> span classn>items1/span>span classp>/span>span classs>quantity/span>span classp>/span> span classo>/span> span classmi>1/span> span classn>items/span>span classp>./span>span classn>append/span>span classp>(/span>span classn>items1/span>span classp>)/span> span classn>transaction/span>span classp>/span>span classs>items/span>span classp>/span> span classo>/span> span classn>items/span> span classn>request/span>span classp>/span>span classs>transaction/span>span classp>/span> span classo>/span> span classn>transaction/span> span classn>request/span>span classp>/span>span classs>autoSend/span>span classp>/span> span classo>/span> span classnb>true/span> span classn>var/span> span classn>customer/span>span classo>:/span> span classp>/span>span classnf>String/span>span classp>:/span>span classn>Any/span>span classp>/span> span classo>/span> span classp>/span>span classo>:/span>span classp>/span> span classn>customer/span>span classp>/span>span classs>customerRef/span>span classp>/span> span classo>/span> span classs>Customer reference string/span> span classn>customer/span>span classp>/span>span classs>firstName/span>span classp>/span> span classo>/span> span classs>FirstName/span> span classn>customer/span>span classp>/span>span classs>lastName/span>span classp>/span> span classo>/span> span classs>LastName/span> span classn>customer/span>span classp>/span>span classs>companyName/span>span classp>/span> span classo>/span> span classs>Company Name/span> span classn>customer/span>span classp>/span>span classs>emailAddress/span>span classp>/span> span classo>/span> span classs>notifications@blockchypteam.m8r.co/span> span classn>customer/span>span classp>/span>span classs>smsNumber/span>span classp>/span> span classo>/span> span classs>(123) 123-1231/span> span classn>request/span>span classp>/span>span classs>customer/span>span classp>/span> span classo>/span> span classn>customer/span> span classp>/span>span classn>client/span> span classnf>sendPaymentLinkWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@url/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@url/span>span classp>)/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>transactionRef/span>span classp>/span> span classo>/span> span classs><TX REF>/span> span classn>request/span>span classp>/span>span classs>amount/span>span classp>/span> span classo>/span> span classs>199.99/span> span classn>request/span>span classp>/span>span classs>description/span>span classp>/span> span classo>/span> span classs>Widget/span> span classn>request/span>span classp>/span>span classs>subject/span>span classp>/span> span classo>/span> span classs>Widget invoice/span> span classk>var/span> span classnv>transaction/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>transaction/span>span classp>/span>span classs>subtotal/span>span classp>/span> span classo>/span> span classs>195.00/span> span classn>transaction/span>span classp>/span>span classs>tax/span>span classp>/span> span classo>/span> span classs>4.99/span> span classn>transaction/span>span classp>/span>span classs>total/span>span classp>/span> span classo>/span> span classs>199.99/span> span classk>var/span> span classnv>items/span> span classo>/span> span classp>/span>span classkt>Any/span>span classp>();/span> span classk>var/span> span classnv>items1/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>items1/span>span classp>/span>span classs>description/span>span classp>/span> span classo>/span> span classs>Widget/span> span classn>items1/span>span classp>/span>span classs>price/span>span classp>/span> span classo>/span> span classs>195.00/span> span classn>items1/span>span classp>/span>span classs>quantity/span>span classp>/span> span classo>/span> span classmi>1/span> span classn>items/span>span classo>./span>span classnf>append/span>span classp>(/span>span classn>items1/span>span classp>)/span> span classn>transaction/span>span classp>/span>span classs>items/span>span classp>/span> span classo>/span> span classn>items/span> span classn>request/span>span classp>/span>span classs>transaction/span>span classp>/span> span classo>/span> span classn>transaction/span> span classn>request/span>span classp>/span>span classs>autoSend/span>span classp>/span> span classo>/span> span classkc>true/span> span classk>var/span> span classnv>customer/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>customer/span>span classp>/span>span classs>customerRef/span>span classp>/span> span classo>/span> span classs>Customer reference string/span> span classn>customer/span>span classp>/span>span classs>firstName/span>span classp>/span> span classo>/span> span classs>FirstName/span> span classn>customer/span>span classp>/span>span classs>lastName/span>span classp>/span> span classo>/span> span classs>LastName/span> span classn>customer/span>span classp>/span>span classs>companyName/span>span classp>/span> span classo>/span> span classs>Company Name/span> span classn>customer/span>span classp>/span>span classs>emailAddress/span>span classp>/span> span classo>/span> span classs>notifications@blockchypteam.m8r.co/span> span classn>customer/span>span classp>/span>span classs>smsNumber/span>span classp>/span> span classo>/span> span classs>(123) 123-1231/span> span classn>request/span>span classp>/span>span classs>customer/span>span classp>/span> span classo>/span> span classn>customer/span> span classn>client/span>span classo>./span>span classnf>sendPaymentLink/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classkt>NSLog/span>span classp>(/span>span classs>url/span> span classo>+/span> span classs>: /span> span classo>+/span> span classp>(/span>span classn>response/span>span classp>/span>span classs>url/span>span classp>/span> span classk>as?/span> span classkt>String/span>span classp>)/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>send_payment_link_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>PaymentLinkRequest/span>span classp>{/span> span classn>transaction_ref/span>span classp>:/span> span classs><TX REF>/span>span classnf>.to_string/span>span classp>(),/span> span classn>amount/span>span classp>:/span> span classs>199.99/span>span classnf>.to_string/span>span classp>(),/span> span classn>description/span>span classp>:/span> span classs>Widget/span>span classnf>.to_string/span>span classp>(),/span> span classn>subject/span>span classp>:/span> span classs>Widget invoice/span>span classnf>.to_string/span>span classp>(),/span> span classn>transaction/span>span classp>:/span> span classnf>Some/span>span classp>(/span>span classnn>blockchyp/span>span classp>::/span>span classn>TransactionDisplayTransaction/span>span classp>{/span> span classn>subtotal/span>span classp>:/span> span classs>195.00/span>span classnf>.to_string/span>span classp>(),/span> span classn>tax/span>span classp>:/span> span classs>4.99/span>span classnf>.to_string/span>span classp>(),/span> span classn>total/span>span classp>:/span> span classs>199.99/span>span classnf>.to_string/span>span classp>(),/span> span classn>items/span>span classp>:/span> span classnf>Some/span>span classp>(/span>span classnd>vec!/span>span classp>/span> span classnn>blockchyp/span>span classp>::/span>span classn>TransactionDisplayItem/span>span classp>{/span> span classn>description/span>span classp>:/span> span classs>Widget/span>span classnf>.to_string/span>span classp>(),/span> span classn>price/span>span classp>:/span> span classs>195.00/span>span classnf>.to_string/span>span classp>(),/span> span classn>quantity/span>span classp>:/span> span classmf>1.0/span>span classp>,/span> .span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>},/span> span classp>),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>}),/span> span classn>auto_send/span>span classp>:/span> span classk>true/span>span classp>,/span> span classn>customer/span>span classp>:/span> span classnn>blockchyp/span>span classp>::/span>span classn>Customer/span>span classp>{/span> span classn>customer_ref/span>span classp>:/span> span classs>Customer reference string/span>span classnf>.to_string/span>span classp>(),/span> span classn>first_name/span>span classp>:/span> span classs>FirstName/span>span classnf>.to_string/span>span classp>(),/span> span classn>last_name/span>span classp>:/span> span classs>LastName/span>span classnf>.to_string/span>span classp>(),/span> span classn>company_name/span>span classp>:/span> span classs>Company Name/span>span classnf>.to_string/span>span classp>(),/span> span classn>email_address/span>span classp>:/span> span classs>notifications@blockchypteam.m8r.co/span>span classnf>.to_string/span>span classp>(),/span> span classn>sms_number/span>span classp>:/span> span classs>(123) 123-1231/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>},/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.send_payment_link/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>send_payment_link_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>linkCode/span>span classp>:/span>span classw> /span>span classs2>JUC37V2V57337Q5FA7WWTK6GAQ/span>span classp>,/span>span classw> /span>span classs2>url/span>span classp>:/span>span classw> /span>span classs2>https://test.blockchyp.com/pay/JUC37V2V57337Q5FA7WWTK6GAQ/span>span classp>,/span>span classw> /span>span classs2>customerId/span>span classp>:/span>span classw> /span>span classs2>BUF36REL4QI6VBVHNSLM7WZLHE/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API allows you to send an invoice to a customer and capture paymentvia a BlockChyp hosted payment page./p>p>If you set the code>autoSend/code> flag, BlockChyp will send a basic invoice emailto the customer for you that includes the payment link. If you'd rather havemore control over the look of the email message, you can omit the code>autoSend/code>flag and send the customer email yourself./p>p>There are a lot of optional parameters for this API, but at a minimumyou'll need to pass in a total, customer name, and email address. (Unlessyou use the code>cashier/code> flag.)/p>p>strong>Customer Info/strong>/p>p>Unless you're using the code>cashier/code> flag, you must specify a customer; either bycreating a new customer record inline or passing in an existing Customer ID or Customer Ref./p>p>strong>Line Item Level Data/strong>/p>p>It's not strictly required, but we strongly recommend sending line item leveldetail with every request. It will make the invoice look more completeand the data format for line item level data is the exact same format usedfor terminal line item display, so the same code can be used to support both areas./p>p>strong>Descriptions/strong>/p>p>You can also provide a free form description or message to display nearthe bottom of the invoice. Usually this is some kind of thank you noteor instruction./p>p>strong>Terms and Conditions/strong>/p>p>You can include long form contract language with a request and captureterms and conditions accepted at the same time payment is captured./p>p>The interface is identical to that used for the terminal based Terms andConditions API in that you can pass in content directly via code>tcContent/code> or viaa preconfigured template via code>tcAlias/code>. The Terms and Conditions log will also be updated whenagreement acceptance is incorporated into a send link request./p>p>strong>Auto Send/strong>/p>p>BlockChyp does not send the email notification automatically. This safeguard prevents real emails from going out when you may not expect them If you want BlockChyp to send the email for you, just add the code>autoSend/code> flag with all requests./p>p>strong>Cryptocurrency/strong>/p>p>If the merchant is configured to support cryptocurrency transactions, the payment page willdisplay additional UI widgets that allowing customers to switch to a crypto payment method./p>p>strong>Tokenization/strong>/p>p>Add the code>enroll/code> flag to a send link request to enroll the payment methodin the token vault./p>p>Add the code>enrollOnly/code> flag to enroll the payment method in the token vault without any immediate payment taking place. The payment link will ask the user for their payment information and inform them that they will not be charged immediately, but that their payment may be used for future transactions./p>p>strong>Cashier Facing Card Entry/strong>/p>p>BlockChyp can be used to generate internal/cashier facing card entry pages as well. This isdesigned for situations where you might need to take a phone order and don'thave an available terminal./p>p>If you pass in the code>cashier/code> flag, no email will be sent and you'll be able toload the link in a browser or iframe for payment entry. When the code>cashier/code> flagis used, the code>autoSend/code> flag will be ignored./p>p>Note that cryptocurrency is not supported for cashier facing payment entry./p>p>strong>Payment Notifications/strong>/p>p>When a customer successfully submits payment, the merchant will receive an emailnotifying them that the payment was received./p>p>strong>Real Time Callback Notifications/strong>/p>p>Email notifications are fine, but you may want your system to be informedimmediately whenever a payment event occurs. By using the optional code>callbackUrl/code> requestproperty, you can specify a URL to which the Authorization Response will be postedevery time the user submits a payment, whether approved or otherwise./p>p>The response will be sent as a JSON encoded POST request and will be the exactsame format as all BlockChyp charge and preauth transaction responses./p>p>strong>Status Polling/strong>/p>p>If real time callbacks aren't practical or necessary in your environment, you canalways use the Payment Link Status API described futher on./p>p>A common use case for the send link API with status polling is curbside pickup.You could have your system check the Payment Link Status when a customer arrives toensure it's been paid without necessarily needing to create background threadsto constantly poll for status updates./p>h2 idresend-payment-link>Resend Payment Link/h2>blockquote>p>Resend Payment Link Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>resend-link/span> -linkCodespan classo>/span>span classs2><PAYMENT LINK CODE>/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>resend-link/span> -linkCodespan classo>/span>span classs2><PAYMENT LINK CODE>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>resendPaymentLinkExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>ResendPaymentLinkRequest/span>span classp>{/span>span classx> /span>span classn>LinkCode/span>span classo>:/span>span classx> /span>span classs><PAYMENT LINK CODE>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>ResendPaymentLink/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>ResendPaymentLinkRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>ResendPaymentLinkRequest/span>span classp>{/span> span classn>LinkCode/span> span classp>/span> span classs><PAYMENT LINK CODE>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>ResendPaymentLinkResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>ResendPaymentLinkAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.ResendPaymentLinkRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.ResendPaymentLinkResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>ResendPaymentLinkExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>ResendPaymentLinkRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>ResendPaymentLinkRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setLinkCode/span>span classo>(/span>span classs><PAYMENT LINK CODE>/span>span classo>);/span> span classc1>// Send the request/span> span classn>ResendPaymentLinkResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>resendPaymentLink/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>linkCode/span> span classo>>/span> span classs1><PAYMENT LINK CODE>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>resendPaymentLink/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>linkCode: /span>span classs1><PAYMENT LINK CODE>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>resendPaymentLink/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>linkCode/span>span classp>:/span> span classs><PAYMENT LINK CODE>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>resend_payment_link/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>resendPaymentLink/span>span classp>({/span> span classna>linkCode/span>span classp>:/span> span classs1><PAYMENT LINK CODE>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>ResendPaymentLinkRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>linkCode/span> span classo>/span> span classs1><PAYMENT LINK CODE>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>resendPaymentLink/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>ResendPaymentLinkResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>linkCode/span>span classp>/span> span classo>/span> span classs><PAYMENT LINK CODE>/span> span classp>/span>span classn>client/span> span classnf>resendPaymentLinkWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>linkCode/span>span classp>/span> span classo>/span> span classs><PAYMENT LINK CODE>/span> span classn>client/span>span classo>./span>span classnf>resendPaymentLink/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>resend_payment_link_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>ResendPaymentLinkRequest/span>span classp>{/span> span classn>link_code/span>span classp>:/span> span classs><PAYMENT LINK CODE>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.resend_payment_link/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>resend_payment_link_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API will resend a previously created payment link. An error is returned if the payment link is expired, has beencancelled, or has already been paid./p>h2 idcancel-payment-link>Cancel Payment Link/h2>blockquote>p>Cancel Payment Link Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>cancel-link/span> -linkCodespan classo>/span>span classs2><PAYMENT LINK CODE>/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>cancel-link/span> -linkCodespan classo>/span>span classs2><PAYMENT LINK CODE>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>cancelPaymentLinkExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>CancelPaymentLinkRequest/span>span classp>{/span>span classx> /span>span classn>LinkCode/span>span classo>:/span>span classx> /span>span classs><PAYMENT LINK CODE>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>CancelPaymentLink/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>CancelPaymentLinkRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>CancelPaymentLinkRequest/span>span classp>{/span> span classn>LinkCode/span> span classp>/span> span classs><PAYMENT LINK CODE>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>CancelPaymentLinkResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>CancelPaymentLinkAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.CancelPaymentLinkRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.CancelPaymentLinkResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>CancelPaymentLinkExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>CancelPaymentLinkRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>CancelPaymentLinkRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setLinkCode/span>span classo>(/span>span classs><PAYMENT LINK CODE>/span>span classo>);/span> span classc1>// Send the request/span> span classn>CancelPaymentLinkResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>cancelPaymentLink/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>linkCode/span> span classo>>/span> span classs1><PAYMENT LINK CODE>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>cancelPaymentLink/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>linkCode: /span>span classs1><PAYMENT LINK CODE>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>cancelPaymentLink/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>linkCode/span>span classp>:/span> span classs><PAYMENT LINK CODE>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>cancel_payment_link/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>cancelPaymentLink/span>span classp>({/span> span classna>linkCode/span>span classp>:/span> span classs1><PAYMENT LINK CODE>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>CancelPaymentLinkRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>linkCode/span> span classo>/span> span classs1><PAYMENT LINK CODE>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>cancelPaymentLink/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>CancelPaymentLinkResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>linkCode/span>span classp>/span> span classo>/span> span classs><PAYMENT LINK CODE>/span> span classp>/span>span classn>client/span> span classnf>cancelPaymentLinkWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>linkCode/span>span classp>/span> span classo>/span> span classs><PAYMENT LINK CODE>/span> span classn>client/span>span classo>./span>span classnf>cancelPaymentLink/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>cancel_payment_link_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>CancelPaymentLinkRequest/span>span classp>{/span> span classn>link_code/span>span classp>:/span> span classs><PAYMENT LINK CODE>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.cancel_payment_link/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>cancel_payment_link_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API cancels a payment link./p>h2 idpayment-link-status>Payment Link Status/h2>blockquote>p>Payment Link Status Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>payment-link-status/span> -linkCodespan classo>/span>span classs2><PAYMENT LINK CODE>/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>payment-link-status/span> -linkCodespan classo>/span>span classs2><PAYMENT LINK CODE>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>paymentLinkStatusExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>PaymentLinkStatusRequest/span>span classp>{/span>span classx> /span>span classn>LinkCode/span>span classo>:/span>span classx> /span>span classs><PAYMENT LINK CODE>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>PaymentLinkStatus/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>PaymentLinkStatusRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>PaymentLinkStatusRequest/span>span classp>{/span> span classn>LinkCode/span> span classp>/span> span classs><PAYMENT LINK CODE>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>PaymentLinkStatusResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>PaymentLinkStatusAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.PaymentLinkStatusRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.PaymentLinkStatusResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>PaymentLinkStatusExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>PaymentLinkStatusRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>PaymentLinkStatusRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setLinkCode/span>span classo>(/span>span classs><PAYMENT LINK CODE>/span>span classo>);/span> span classc1>// Send the request/span> span classn>PaymentLinkStatusResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>paymentLinkStatus/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>linkCode/span> span classo>>/span> span classs1><PAYMENT LINK CODE>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>paymentLinkStatus/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>linkCode: /span>span classs1><PAYMENT LINK CODE>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>paymentLinkStatus/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>linkCode/span>span classp>:/span> span classs><PAYMENT LINK CODE>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>payment_link_status/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>paymentLinkStatus/span>span classp>({/span> span classna>linkCode/span>span classp>:/span> span classs1><PAYMENT LINK CODE>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>PaymentLinkStatusRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>linkCode/span> span classo>/span> span classs1><PAYMENT LINK CODE>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>paymentLinkStatus/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>PaymentLinkStatusResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>linkCode/span>span classp>/span> span classo>/span> span classs><PAYMENT LINK CODE>/span> span classp>/span>span classn>client/span> span classnf>paymentLinkStatusWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>linkCode/span>span classp>/span> span classo>/span> span classs><PAYMENT LINK CODE>/span> span classn>client/span>span classo>./span>span classnf>paymentLinkStatus/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>payment_link_status_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>PaymentLinkStatusRequest/span>span classp>{/span> span classn>link_code/span>span classp>:/span> span classs><PAYMENT LINK CODE>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.payment_link_status/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>payment_link_status_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>linkCode/span>span classp>:/span>span classw> /span>span classs2>WDFAU5UP5U46GLEZEJKZIZDAYA/span>span classp>,/span>span classw> /span>span classs2>merchantId/span>span classp>:/span>span classw> /span>span classs2>3IKWRKY47YI65L7VAJBKYEIAAQ/span>span classp>,/span>span classw> /span>span classs2>customerId/span>span classp>:/span>span classw> /span>span classs2>54QS64R23YI65BHNAJBKYEIAAU/span>span classp>,/span>span classw> /span>span classs2>transactionRef/span>span classp>:/span>span classw> /span>span classs2><TRANSACTION REF>/span>span classp>,/span>span classw> /span>span classs2>orderRef/span>span classp>:/span>span classw> /span>span classs2>12345/span>span classp>,/span>span classw> /span>span classs2>amount/span>span classp>:/span>span classw> /span>span classs2>353.35/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Thank you for your order. Your order will be ready in 20 minutes/span>span classp>,/span>span classw> /span>span classs2>expiration/span>span classp>:/span>span classw> /span>span classs2>2023-10-13T20:12:46Z/span>span classp>,/span>span classw> /span>span classs2>dateCreated/span>span classp>:/span>span classw> /span>span classs2>2023-08-14T20:12:46Z/span>span classp>,/span>span classw> /span>span classs2>transactionDetails/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>subtotal/span>span classp>:/span>span classw> /span>span classs2>327.00/span>span classp>,/span>span classw> /span>span classs2>tax/span>span classp>:/span>span classw> /span>span classs2>16.35/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classs2>353.35/span>span classp>,/span>span classw> /span>span classs2>items/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Hiking Boots/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classs2>120.00/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>extended/span>span classp>:/span>span classw> /span>span classs2>110.00/span>span classp>,/span>span classw> /span>span classs2>unitCode/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>commodityCode/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>productCode/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>discounts/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Member Discount/span>span classp>,/span>span classw> /span>span classs2>amount/span>span classp>:/span>span classw> /span>span classs2>10.00/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>2/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Camping Tent/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classs2>160.00/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>2/span>span classp>,/span>span classw> /span>span classs2>extended/span>span classp>:/span>span classw> /span>span classs2>155.00/span>span classp>,/span>span classw> /span>span classs2>unitCode/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>commodityCode/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>productCode/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>discounts/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Member Discount/span>span classp>,/span>span classw> /span>span classs2>amount/span>span classp>:/span>span classw> /span>span classs2>5.00/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>3/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Backpack/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classs2>70.00/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>extended/span>span classp>:/span>span classw> /span>span classs2>62.00/span>span classp>,/span>span classw> /span>span classs2>unitCode/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>commodityCode/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>productCode/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>discounts/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Member Discount/span>span classp>,/span>span classw> /span>span classs2>amount/span>span classp>:/span>span classw> /span>span classs2>8.00/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>Pending/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API allows you to check on the status of a payment link, including transaction dataand the full history of attempted transactions./p>p>This API is the preferred source of truth and best practice when you want to check on the status of a payment link (as opposed to Transaction Status). The Transaction Status API is not ideal because of ambiguity when there are multiple transactions associated with a single payment link./p>p>You must pass the code>linkCode/code> value associated with the payment link. It is included in the response from BlockChyp when the payment link is originally created./p>h2 idtransaction-status>Transaction Status/h2>blockquote>p>Transaction Status Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>tx-status/span> -txspan classo>/span>span classs2><TRANSACTION ID>/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>tx-status/span> -txspan classo>/span>span classs2><TRANSACTION ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>transactionStatusExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>TransactionStatusRequest/span>span classp>{/span>span classx> /span>span classn>TransactionID/span>span classo>:/span>span classx> /span>span classs><TRANSACTION ID>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>TransactionStatus/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>TransactionStatusRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>TransactionStatusRequest/span>span classp>{/span> span classn>TransactionId/span> span classp>/span> span classs><TRANSACTION ID>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>AuthorizationResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>TransactionStatusAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TransactionStatusRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.AuthorizationResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>TransactionStatusExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>TransactionStatusRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>TransactionStatusRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTransactionId/span>span classo>(/span>span classs><TRANSACTION ID>/span>span classo>);/span> span classc1>// Send the request/span> span classn>AuthorizationResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>transactionStatus/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>transactionId/span> span classo>>/span> span classs1><TRANSACTION ID>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>transactionStatus/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>transactionId: /span>span classs1><TRANSACTION ID>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>transactionStatus/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>transactionId/span>span classp>:/span> span classs><TRANSACTION ID>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>transaction_status/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>transactionStatus/span>span classp>({/span> span classna>transactionId/span>span classp>:/span> span classs1><TRANSACTION ID>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TransactionStatusRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>transactionId/span> span classo>/span> span classs1><TRANSACTION ID>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>transactionStatus/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>AuthorizationResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>transactionId/span>span classp>/span> span classo>/span> span classs><TRANSACTION ID>/span> span classp>/span>span classn>client/span> span classnf>transactionStatusWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@responseDescription/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@responseDescription/span>span classp>)/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@authorizedAmount/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@authorizedAmount/span>span classp>)/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>transactionId/span>span classp>/span> span classo>/span> span classs><TRANSACTION ID>/span> span classn>client/span>span classo>./span>span classnf>transactionStatus/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classkt>NSLog/span>span classp>(/span>span classs>responseDescription/span> span classo>+/span> span classs>: /span> span classo>+/span> span classp>(/span>span classn>response/span>span classp>/span>span classs>responseDescription/span>span classp>/span> span classk>as?/span> span classkt>String/span>span classp>)/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classkt>NSLog/span>span classp>(/span>span classs>authorizedAmount/span> span classo>+/span> span classs>: /span> span classo>+/span> span classp>(/span>span classn>response/span>span classp>/span>span classs>authorizedAmount/span>span classp>/span> span classk>as?/span> span classkt>String/span>span classp>)/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>transaction_status_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>TransactionStatusRequest/span>span classp>{/span> span classn>transaction_id/span>span classp>:/span> span classs><TRANSACTION ID>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.transaction_status/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>transaction_status_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>approved/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>authCode/span>span classp>:/span>span classw> /span>span classs2>782472/span>span classp>,/span>span classw> /span>span classs2>transactionId/span>span classp>:/span>span classw> /span>span classs2>GH7FEIUL64I6VILZNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>GH7EWQUL64I6VILZNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>transactionRef/span>span classp>:/span>span classw> /span>span classs2>MYTXREF/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>charge/span>span classp>,/span>span classw> /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classs2>2020-05-01T22:00:39Z/span>span classp>,/span>span classw> /span>span classs2>tickBlock/span>span classp>:/span>span classw> /span>span classs2>009991a8ac7b6a4420760e1e14e1689c88be2a610a033d6908c1b04b5c00f9da/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>partialAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>altCurrency/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>fsaAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>currencyCode/span>span classp>:/span>span classw> /span>span classs2>USD/span>span classp>,/span>span classw> /span>span classs2>requestedAmount/span>span classp>:/span>span classw> /span>span classs2>125.05/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>125.05/span>span classp>,/span>span classw> /span>span classs2>remainingBalance/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>tipAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>taxAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>requestedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>authorizedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>KEYED/span>span classp>,/span>span classw> /span>span classs2>paymentType/span>span classp>:/span>span classw> /span>span classs2>VISA/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************1111/span>span classp>,/span>span classw> /span>span classs2>cardHolder/span>span classp>:/span>span classw> /span>span classs2>PETER GREGORY/span>span classp>,/span>span classw> /span>span classs2>avsResponse/span>span classp>:/span>span classw> /span>span classs2>N/span>span classp>,/span>span classw> /span>span classs2>receiptSuggestions/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>merchantName/span>span classp>:/span>span classw> /span>span classs2>Test Merchant/span>span classp>,/span>span classw> /span>span classs2>merchantId/span>span classp>:/span>span classw> /span>span classs2>BUF36EUL4QI6VBUZNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>requestSignature/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************1111/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>125.05/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>charge/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>KEYED/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>customer/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>BUF36REL4QI6VBVJNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>customerRef/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>firstName/span>span classp>:/span>span classw> /span>span classs2>Peter/span>span classp>,/span>span classw> /span>span classs2>lastName/span>span classp>:/span>span classw> /span>span classs2>Gregory/span>span classp>,/span>span classw> /span>span classs2>companyName/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>emailAddress/span>span classp>:/span>span classw> /span>span classs2>pgregory@raviga.com/span>span classp>,/span>span classw> /span>span classs2>smsNumber/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>paymentMethods/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>whiteListedCard/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>storeAndForward/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API returns the current status for any transaction. You can lookup a transactionby its BlockChyp assigned Transaction ID or your own Transaction Ref./p>p>You should always use globally unique Transaction Ref values, but in the eventthat you duplicate Transaction Refs, the most recent transaction matching yourTransaction Ref is returned./p>h2 idcash-discount>Cash Discount/h2>blockquote>p>Cash Discount Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>cash-discount/span> -amountspan classo>/span>span classs2>100.00/span> -surcharge -cashDiscountWindows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>cash-discount/span> -amountspan classo>/span>span classs2>100.00/span> -surcharge -cashDiscount/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>cashDiscountExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>CashDiscountRequest/span>span classp>{/span>span classx> /span>span classn>Amount/span>span classo>:/span>span classx> /span>span classs>100.00/span>span classp>,/span>span classx> /span>span classn>CashDiscount/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classn>Surcharge/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>CashDiscount/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>CashDiscountRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>CashDiscountRequest/span>span classp>{/span> span classn>Amount/span> span classp>/span> span classs>100.00/span>span classp>,/span> span classn>CashDiscount/span> span classp>/span> span classk>true/span>span classp>,/span> span classn>Surcharge/span> span classp>/span> span classk>true/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>CashDiscountResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>CashDiscountAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.CashDiscountRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.CashDiscountResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>CashDiscountExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>CashDiscountRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>CashDiscountRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setAmount/span>span classo>(/span>span classs>100.00/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setCashDiscount/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setSurcharge/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classc1>// Send the request/span> span classn>CashDiscountResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>cashDiscount/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>amount/span> span classo>>/span> span classs1>100.00/span>span classp>,/span> span classs1>cashDiscount/span> span classo>>/span> span classkc>true/span>span classp>,/span> span classs1>surcharge/span> span classo>>/span> span classkc>true/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>cashDiscount/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>amount: /span>span classs1>100.00/span>span classp>,/span> span classss>cashDiscount: /span>span classkp>true/span>span classp>,/span> span classss>surcharge: /span>span classkp>true/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>cashDiscount/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>amount/span>span classp>:/span> span classs>100.00/span>span classp>,/span> span classs>cashDiscount/span>span classp>:/span> span classbp>True/span>span classp>,/span> span classs>surcharge/span>span classp>:/span> span classbp>True/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>cash_discount/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>cashDiscount/span>span classp>({/span> span classna>amount/span>span classp>:/span> span classs1>100.00/span>span classp>,/span> span classna>cashDiscount/span>span classp>:/span> span classkc>true/span>span classp>,/span> span classna>surcharge/span>span classp>:/span> span classkc>true/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>CashDiscountRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>amount/span> span classo>/span> span classs1>100.00/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>cashDiscount/span> span classo>/span> span classkc>true/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>surcharge/span> span classo>/span> span classkc>true/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>cashDiscount/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>CashDiscountResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>amount/span>span classp>/span> span classo>/span> span classs>100.00/span> span classn>request/span>span classp>/span>span classs>cashDiscount/span>span classp>/span> span classo>/span> span classnb>true/span> span classn>request/span>span classp>/span>span classs>surcharge/span>span classp>/span> span classo>/span> span classnb>true/span> span classp>/span>span classn>client/span> span classnf>cashDiscountWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@amount/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@amount/span>span classp>)/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>amount/span>span classp>/span> span classo>/span> span classs>100.00/span> span classn>request/span>span classp>/span>span classs>cashDiscount/span>span classp>/span> span classo>/span> span classkc>true/span> span classn>request/span>span classp>/span>span classs>surcharge/span>span classp>/span> span classo>/span> span classkc>true/span> span classn>client/span>span classo>./span>span classnf>cashDiscount/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classkt>NSLog/span>span classp>(/span>span classs>amount/span> span classo>+/span> span classs>: /span> span classo>+/span> span classp>(/span>span classn>response/span>span classp>/span>span classs>amount/span>span classp>/span> span classk>as?/span> span classkt>String/span>span classp>)/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>cash_discount_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>CashDiscountRequest/span>span classp>{/span> span classn>amount/span>span classp>:/span> span classs>100.00/span>span classnf>.to_string/span>span classp>(),/span> span classn>cash_discount/span>span classp>:/span> span classk>true/span>span classp>,/span> span classn>surcharge/span>span classp>:/span> span classk>true/span>span classp>,/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.cash_discount/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>cash_discount_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>currencyCode/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>amount/span>span classp>:/span>span classw> /span>span classs2>100.00/span>span classp>,/span>span classw> /span>span classs2>taxExempt/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>surcharge/span>span classp>:/span>span classw> /span>span classs2>3.81/span>span classp>,/span>span classw> /span>span classs2>cashDiscount/span>span classp>:/span>span classw> /span>span classs2>3.81/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API calculates the surcharge, cash discount, and total amounts for cash transactions./p>p>If you're using BlockChyp's cash discounting features, you can use this endpointto ensure the numbers and receipts for true cash transactions are consistentwith transactions processed by BlockChyp./p>aside classwarning>Make sure you use the same values for code>surcharge/code> and code>cashDiscount/code>as you do for running conventional payment transactions./aside>h2 idbatch-history>Batch History/h2>blockquote>p>Batch History Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>batch-history/span> -maxResultsspan classo>/span>span classs2>250/span> -startIndexspan classo>/span>span classs2>1/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>batch-history/span> -maxResultsspan classo>/span>span classs2>250/span> -startIndexspan classo>/span>span classs2>1/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>batchHistoryExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>BatchHistoryRequest/span>span classp>{/span>span classx> /span>span classn>MaxResults/span>span classo>:/span>span classx> /span>span classm>250/span>span classp>,/span>span classx> /span>span classn>StartIndex/span>span classo>:/span>span classx> /span>span classm>0/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>BatchHistory/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>BatchHistoryRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>BatchHistoryRequest/span>span classp>{/span> span classn>MaxResults/span> span classp>/span> span classm>250/span>span classp>,/span> span classn>StartIndex/span> span classp>/span> span classm>0/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>BatchHistoryResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>BatchHistoryAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.BatchHistoryRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.BatchHistoryResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>BatchHistoryExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>BatchHistoryRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>BatchHistoryRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setMaxResults/span>span classo>(/span>span classmi>250/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setStartIndex/span>span classo>(/span>span classmi>0/span>span classo>);/span> span classc1>// Send the request/span> span classn>BatchHistoryResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>batchHistory/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>maxResults/span> span classo>>/span> span classmi>250/span>span classp>,/span> span classs1>startIndex/span> span classo>>/span> span classmi>0/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>batchHistory/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>maxResults: /span>span classmi>250/span>span classp>,/span> span classss>startIndex: /span>span classmi>0/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>batchHistory/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>maxResults/span>span classp>:/span> span classmi>250/span>span classp>,/span> span classs>startIndex/span>span classp>:/span> span classmi>0/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>batch_history/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>batchHistory/span>span classp>({/span> span classna>maxResults/span>span classp>:/span> span classmi>250/span>span classp>,/span> span classna>startIndex/span>span classp>:/span> span classmi>0/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>BatchHistoryRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>maxResults/span> span classo>/span> span classmi>250/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>startIndex/span> span classo>/span> span classmi>0/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>batchHistory/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>BatchHistoryResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>maxResults/span>span classp>/span> span classo>/span> span classmi>250/span> span classn>request/span>span classp>/span>span classs>startIndex/span>span classp>/span> span classo>/span> span classmi>0/span> span classp>/span>span classn>client/span> span classnf>batchHistoryWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>maxResults/span>span classp>/span> span classo>/span> span classmi>250/span> span classn>request/span>span classp>/span>span classs>startIndex/span>span classp>/span> span classo>/span> span classmi>0/span> span classn>client/span>span classo>./span>span classnf>batchHistory/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>batch_history_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>BatchHistoryRequest/span>span classp>{/span> span classn>max_results/span>span classp>:/span> span classmi>250/span>span classp>,/span> span classn>start_index/span>span classp>:/span> span classmi>0/span>span classp>,/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.batch_history/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>batch_history_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>startDate/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>endDate/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>batches/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>OPXQNZEUSAI6VL2FNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>capturedAmount/span>span classp>:/span>span classw> /span>span classs2>146.44/span>span classp>,/span>span classw> /span>span classs2>open/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>openDate/span>span classp>:/span>span classw> /span>span classs2>2020-05-12T20:45:28Z/span>span classp>,/span>span classw> /span>span classs2>closeDate/span>span classp>:/span>span classw> /span>span classs2>0001-01-01T00:00:00Z/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>OPXQNZEUSAI6VL2CNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>capturedAmount/span>span classp>:/span>span classw> /span>span classs2>57.79/span>span classp>,/span>span classw> /span>span classs2>open/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>openDate/span>span classp>:/span>span classw> /span>span classs2>2020-05-12T20:44:11Z/span>span classp>,/span>span classw> /span>span classs2>closeDate/span>span classp>:/span>span classw> /span>span classs2>2020-05-12T20:45:00Z/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classs2>maxResults/span>span classp>:/span>span classw> /span>span classmi>250/span>span classp>,/span>span classw> /span>span classs2>startIndex/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalResultCount/span>span classp>:/span>span classw> /span>span classmi>2/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This endpoint allows developers to query the gateway for the merchant's batch history.The data will be returned in descending order of open date with the most recentbatch returned first. The results will include basic information about the batch.Consider using the Batch Details API for more detail about a specific batch./p>p>strong>Limiting Results/strong>/p>p>This API will return a maximum of 250 results. Use the code>maxResults/code> property tolimit maximum results even further and use the code>startIndex/code> property topage through results that span multiple queries./p>p>For example, if you want the ten most recent batches, pass in a value ofcode>10/code> for code>maxResults/code>. Also note that code>startIndex/code> is zero based. Use a value of code>0/code> toget the first batch in the dataset./p>p>strong>Filtering by Date Range/strong>/p>p>You can also filter results by date. Use the code>startDate/code> and code>endDate/code>properties to return only those batches opened between those dates.You can use either code>startDate/code> and code>endDate/code> and you can use date filtersin conjunction with code>maxResults/code> and code>startIndex/code>/p>h2 idbatch-details>Batch Details/h2>blockquote>p>Batch Details Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>batch-details/span> -batchIdspan classo>/span>span classs2><BATCH ID>/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>batch-details/span> -batchIdspan classo>/span>span classs2><BATCH ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>batchDetailsExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>BatchDetailsRequest/span>span classp>{/span>span classx> /span>span classn>BatchID/span>span classo>:/span>span classx> /span>span classs><BATCH ID>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>BatchDetails/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>BatchDetailsRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>BatchDetailsRequest/span>span classp>{/span> span classn>BatchId/span> span classp>/span> span classs><BATCH ID>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>BatchDetailsResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>BatchDetailsAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.BatchDetailsRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.BatchDetailsResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>BatchDetailsExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>BatchDetailsRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>BatchDetailsRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setBatchId/span>span classo>(/span>span classs><BATCH ID>/span>span classo>);/span> span classc1>// Send the request/span> span classn>BatchDetailsResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>batchDetails/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>batchId/span> span classo>>/span> span classs1><BATCH ID>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>batchDetails/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>batchId: /span>span classs1><BATCH ID>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>batchDetails/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>batchId/span>span classp>:/span> span classs><BATCH ID>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>batch_details/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>batchDetails/span>span classp>({/span> span classna>batchId/span>span classp>:/span> span classs1><BATCH ID>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>BatchDetailsRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>batchId/span> span classo>/span> span classs1><BATCH ID>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>batchDetails/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>BatchDetailsResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>batchId/span>span classp>/span> span classo>/span> span classs><BATCH ID>/span> span classp>/span>span classn>client/span> span classnf>batchDetailsWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@capturedAmount/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@capturedAmount/span>span classp>)/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>batchId/span>span classp>/span> span classo>/span> span classs><BATCH ID>/span> span classn>client/span>span classo>./span>span classnf>batchDetails/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classkt>NSLog/span>span classp>(/span>span classs>capturedAmount/span> span classo>+/span> span classs>: /span> span classo>+/span> span classp>(/span>span classn>response/span>span classp>/span>span classs>capturedAmount/span>span classp>/span> span classk>as?/span> span classkt>String/span>span classp>)/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>batch_details_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>BatchDetailsRequest/span>span classp>{/span> span classn>batch_id/span>span classp>:/span> span classs><BATCH ID>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.batch_details/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>batch_details_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>OPXQNZEUSAI6VL2FNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>capturedAmount/span>span classp>:/span>span classw> /span>span classs2>294.12/span>span classp>,/span>span classw> /span>span classs2>openPreauths/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>totalVolume/span>span classp>:/span>span classw> /span>span classs2>294.12/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>5/span>span classp>,/span>span classw> /span>span classs2>giftCardsSold/span>span classp>:/span>span classw> /span>span classs2>50.00/span>span classp>,/span>span classw> /span>span classs2>giftCardVolume/span>span classp>:/span>span classw> /span>span classs2>12.00/span>span classp>,/span>span classw> /span>span classs2>expectedDeposit/span>span classp>:/span>span classw> /span>span classs2>282.12/span>span classp>,/span>span classw> /span>span classs2>open/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>openDate/span>span classp>:/span>span classw> /span>span classs2>2020-05-12T20:45:28Z/span>span classp>,/span>span classw> /span>span classs2>closeDate/span>span classp>:/span>span classw> /span>span classs2>0001-01-01T00:00:00Z/span>span classp>,/span>span classw> /span>span classs2>volumeByTerminal/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>terminalName/span>span classp>:/span>span classw> /span>span classs2>POS1/span>span classp>,/span>span classw> /span>span classs2>serialNumber/span>span classp>:/span>span classw> /span>span classs2>A18290030XXXX/span>span classp>,/span>span classw> /span>span classs2>terminalType/span>span classp>:/span>span classw> /span>span classs2>LUXE8000/span>span classp>,/span>span classw> /span>span classs2>capturedAmount/span>span classp>:/span>span classw> /span>span classs2>147.68/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>2/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>terminalName/span>span classp>:/span>span classw> /span>span classs2>POS2/span>span classp>,/span>span classw> /span>span classs2>serialNumber/span>span classp>:/span>span classw> /span>span classs2>A182700300XXXX/span>span classp>,/span>span classw> /span>span classs2>terminalType/span>span classp>:/span>span classw> /span>span classs2>LUXE8000/span>span classp>,/span>span classw> /span>span classs2>capturedAmount/span>span classp>:/span>span classw> /span>span classs2>146.44/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>3/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API allows developers to pull down details for a specific batch,including captured volume, gift card activity, expected deposit, andcaptured volume broken down by terminal./p>p>The only required request parameter is code>batchId/code>. Batch IDs are returnedwith every transaction response and can be discovered using the BatchHistory API./p>h2 idtransaction-history>Transaction History/h2>blockquote>p>Transaction History Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>tx-history/span> -batchIdspan classo>/span>span classs2><BATCH ID>/span> -maxResultsspan classo>/span>span classs2>10/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>tx-history/span> -batchIdspan classo>/span>span classs2><BATCH ID>/span> -maxResultsspan classo>/span>span classs2>10/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>transactionHistoryExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>TransactionHistoryRequest/span>span classp>{/span>span classx> /span>span classn>MaxResults/span>span classo>:/span>span classx> /span>span classm>10/span>span classp>,/span>span classx> /span>span classn>BatchID/span>span classo>:/span>span classx> /span>span classs><BATCH ID>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>TransactionHistory/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>TransactionHistoryRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>TransactionHistoryRequest/span>span classp>{/span> span classn>MaxResults/span> span classp>/span> span classm>10/span>span classp>,/span> span classn>BatchId/span> span classp>/span> span classs><BATCH ID>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>TransactionHistoryResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>TransactionHistoryAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TransactionHistoryRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TransactionHistoryResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>TransactionHistoryExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>TransactionHistoryRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>TransactionHistoryRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setMaxResults/span>span classo>(/span>span classmi>10/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setBatchId/span>span classo>(/span>span classs><BATCH ID>/span>span classo>);/span> span classc1>// Send the request/span> span classn>TransactionHistoryResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>transactionHistory/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>maxResults/span> span classo>>/span> span classmi>10/span>span classp>,/span> span classs1>batchId/span> span classo>>/span> span classs1><BATCH ID>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>transactionHistory/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>maxResults: /span>span classmi>10/span>span classp>,/span> span classss>batchId: /span>span classs1><BATCH ID>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>transactionHistory/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>maxResults/span>span classp>:/span> span classmi>10/span>span classp>,/span> span classs>batchId/span>span classp>:/span> span classs><BATCH ID>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>transaction_history/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>transactionHistory/span>span classp>({/span> span classna>maxResults/span>span classp>:/span> span classmi>10/span>span classp>,/span> span classna>batchId/span>span classp>:/span> span classs1><BATCH ID>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TransactionHistoryRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>maxResults/span> span classo>/span> span classmi>10/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>batchId/span> span classo>/span> span classs1><BATCH ID>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>transactionHistory/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TransactionHistoryResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>maxResults/span>span classp>/span> span classo>/span> span classmi>10/span> span classn>request/span>span classp>/span>span classs>batchId/span>span classp>/span> span classo>/span> span classs><BATCH ID>/span> span classp>/span>span classn>client/span> span classnf>transactionHistoryWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>maxResults/span>span classp>/span> span classo>/span> span classmi>10/span> span classn>request/span>span classp>/span>span classs>batchId/span>span classp>/span> span classo>/span> span classs><BATCH ID>/span> span classn>client/span>span classo>./span>span classnf>transactionHistory/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>transaction_history_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>TransactionHistoryRequest/span>span classp>{/span> span classn>max_results/span>span classp>:/span> span classmi>10/span>span classp>,/span> span classn>batch_id/span>span classp>:/span> span classs><BATCH ID>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.transaction_history/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>transaction_history_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>terminalName/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>startDate/span>span classp>:/span>span classw> /span>span classs2>0001-01-01T00:00:00Z/span>span classp>,/span>span classw> /span>span classs2>endDate/span>span classp>:/span>span classw> /span>span classs2>0001-01-01T00:00:00Z/span>span classp>,/span>span classw> /span>span classs2>maxResults/span>span classp>:/span>span classw> /span>span classmi>2/span>span classp>,/span>span classw> /span>span classs2>startIndex/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalResultCount/span>span classp>:/span>span classw> /span>span classmi>7/span>span classp>,/span>span classw> /span>span classs2>transactions/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>approved/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>authCode/span>span classp>:/span>span classw> /span>span classs2>324858/span>span classp>,/span>span classw> /span>span classs2>transactionId/span>span classp>:/span>span classw> /span>span classs2>OPXQN6EUSAI6VL2MNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>OPXQNZEUSAI6VL2FNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>transactionRef/span>span classp>:/span>span classw> /span>span classs2>88277082628/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>charge/span>span classp>,/span>span classw> /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classs2>2020-05-12T21:00:22Z/span>span classp>,/span>span classw> /span>span classs2>tickBlock/span>span classp>:/span>span classw> /span>span classs2>009991a8ac7b6a4420760e1e14e1689c88be2a610a033d6908c1b04b5c00f9da/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>partialAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>altCurrency/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>fsaAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>currencyCode/span>span classp>:/span>span classw> /span>span classs2>USD/span>span classp>,/span>span classw> /span>span classs2>requestedAmount/span>span classp>:/span>span classw> /span>span classs2>34.34/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>34.34/span>span classp>,/span>span classw> /span>span classs2>remainingBalance/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>tipAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>taxAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>requestedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>authorizedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>CONTACTLESS EMV/span>span classp>,/span>span classw> /span>span classs2>paymentType/span>span classp>:/span>span classw> /span>span classs2>AMEX/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>***********1006/span>span classp>,/span>span classw> /span>span classs2>cardHolder/span>span classp>:/span>span classw> /span>span classs2>UAT USA/Test Card 12/span>span classp>,/span>span classw> /span>span classs2>avsResponse/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>receiptSuggestions/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>aid/span>span classp>:/span>span classw> /span>span classs2>A000000025010402/span>span classp>,/span>span classw> /span>span classs2>arqc/span>span classp>:/span>span classw> /span>span classs2>B5D6F55680D4B628/span>span classp>,/span>span classw> /span>span classs2>iad/span>span classp>:/span>span classw> /span>span classs2>06020103A02800/span>span classp>,/span>span classw> /span>span classs2>tvr/span>span classp>:/span>span classw> /span>span classs2>8000008000/span>span classp>,/span>span classw> /span>span classs2>terminalId/span>span classp>:/span>span classw> /span>span classs2>OPXQN3UUSAI6VL2JNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>merchantName/span>span classp>:/span>span classw> /span>span classs2>Test Merchant/span>span classp>,/span>span classw> /span>span classs2>merchantId/span>span classp>:/span>span classw> /span>span classs2>KUV2WLUURYI6VLFSNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>requestSignature/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>***********1006/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>34.34/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>charge/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>CONTACTLESS EMV/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>customer/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>whiteListedCard/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>storeAndForward/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>approved/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>authCode/span>span classp>:/span>span classw> /span>span classs2>554632/span>span classp>,/span>span classw> /span>span classs2>transactionId/span>span classp>:/span>span classw> /span>span classs2>OPXQN6EUSAI6VL2LNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>OPXQNZEUSAI6VL2FNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>transactionRef/span>span classp>:/span>span classw> /span>span classs2>00036850216/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>charge/span>span classp>,/span>span classw> /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classs2>2020-05-12T21:00:03Z/span>span classp>,/span>span classw> /span>span classs2>tickBlock/span>span classp>:/span>span classw> /span>span classs2>009991a8ac7b6a4420760e1e14e1689c88be2a610a033d6908c1b04b5c00f9da/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>partialAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>altCurrency/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>fsaAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>currencyCode/span>span classp>:/span>span classw> /span>span classs2>USD/span>span classp>,/span>span classw> /span>span classs2>requestedAmount/span>span classp>:/span>span classw> /span>span classs2>113.34/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>113.34/span>span classp>,/span>span classw> /span>span classs2>remainingBalance/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>tipAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>taxAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>requestedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>authorizedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>CHIP/span>span classp>,/span>span classw> /span>span classs2>paymentType/span>span classp>:/span>span classw> /span>span classs2>VISA/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************0010/span>span classp>,/span>span classw> /span>span classs2>cardHolder/span>span classp>:/span>span classw> /span>span classs2>UAT USA/Test Card 04/span>span classp>,/span>span classw> /span>span classs2>avsResponse/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>receiptSuggestions/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>aid/span>span classp>:/span>span classw> /span>span classs2>A0000000031010/span>span classp>,/span>span classw> /span>span classs2>arqc/span>span classp>:/span>span classw> /span>span classs2>07FC47906F51B4E9/span>span classp>,/span>span classw> /span>span classs2>iad/span>span classp>:/span>span classw> /span>span classs2>06010A03A0B800/span>span classp>,/span>span classw> /span>span classs2>tvr/span>span classp>:/span>span classw> /span>span classs2>8000008800/span>span classp>,/span>span classw> /span>span classs2>terminalId/span>span classp>:/span>span classw> /span>span classs2>OPXQN3UUSAI6VL2JNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>merchantName/span>span classp>:/span>span classw> /span>span classs2>Test Merchant/span>span classp>,/span>span classw> /span>span classs2>merchantId/span>span classp>:/span>span classw> /span>span classs2>KUV2WLUURYI6VLFSNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>requestSignature/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************0010/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>113.34/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>charge/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>CHIP/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>customer/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>whiteListedCard/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>storeAndForward/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This endpoint provides several different methods to sift throughtransaction history./p>p>By default with no filtering properties, this endpoint will return the 250most recent transactions./p>p>strong>Limiting Results/strong>/p>p>This API will return a maximum of 50 results in a single query. Use the code>maxResults/code> propertyto limit maximum results even further and use the code>startIndex/code> property topage through results that span multiple queries./p>p>For example, if you want the ten most recent batches, pass in a value ofcode>10/code> for code>maxResults/code>. Also note that code>startIndex/code> is zero based. Use a value of code>0/code> toget the first transaction in the dataset./p>p>strong>Filtering By Date Range/strong>/p>p>You can also filter results by date. Use the code>startDate/code> and code>endDate/code>properties to return only transactions run between those dates.You can use either code>startDate/code> or code>endDate/code> and you can use date filtersin conjunction with code>maxResults/code> and code>startIndex/code>/p>p>strong>Filtering By Batch/strong>/p>p>To restrict results to a single batch, pass in the code>batchId/code> parameter./p>p>strong>Filtering By Terminal/strong>/p>p>To restrict results to those executed on a single terminal, pass in the terminal name./p>p>strong>Combining Filters/strong>/p>p>None of the above filters are mutually exclusive. You can combine any of theabove properties in a single request to restrict transaction results to anarrower set of results./p>p>strong>Searching Transaction History/strong>/p>p>You can search transaction history by passing in search criteria with the code>query/code> option. The search system will match the amount (requested and authorized),last four of the card number, cardholder name, and the auth code./p>p>Note that when search queries are used, terminalName or batch id filters are not supported./p>h2 idlist-queued-transactions>List Queued Transactions/h2>blockquote>p>List Queued Transactions Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>list-queue/span> -terminalspan classo>/span>span classs2>Test Terminal/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>list-queue/span> -terminalspan classo>/span>span classs2>Test Terminal/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>listQueuedTransactionsExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>ListQueuedTransactionsRequest/span>span classp>{/span>span classx> /span>span classn>TerminalName/span>span classo>:/span>span classx> /span>span classs>Test Terminal/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>ListQueuedTransactions/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>ListQueuedTransactionsRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>ListQueuedTransactionsRequest/span>span classp>{/span> span classn>TerminalName/span> span classp>/span> span classs>Test Terminal/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>ListQueuedTransactionsResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>ListQueuedTransactionsAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.ListQueuedTransactionsRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.ListQueuedTransactionsResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>ListQueuedTransactionsExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>ListQueuedTransactionsRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>ListQueuedTransactionsRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTerminalName/span>span classo>(/span>span classs>Test Terminal/span>span classo>);/span> span classc1>// Send the request/span> span classn>ListQueuedTransactionsResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>listQueuedTransactions/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>terminalName/span> span classo>>/span> span classs1>Test Terminal/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>listQueuedTransactions/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>terminalName: /span>span classs1>Test Terminal/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>listQueuedTransactions/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>terminalName/span>span classp>:/span> span classs>Test Terminal/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>list_queued_transactions/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>listQueuedTransactions/span>span classp>({/span> span classna>terminalName/span>span classp>:/span> span classs1>Test Terminal/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>ListQueuedTransactionsRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>terminalName/span> span classo>/span> span classs1>Test Terminal/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>listQueuedTransactions/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>ListQueuedTransactionsResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classp>/span>span classn>client/span> span classnf>listQueuedTransactionsWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>client/span>span classo>./span>span classnf>listQueuedTransactions/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>list_queued_transactions_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classk>mut/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>ListQueuedTransactionsRequest/span>span classp>{/span> span classn>terminal_name/span>span classp>:/span> span classs>Test Terminal/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.list_queued_transactions/span>span classp>(/span>span classo>&/span>span classk>mut/span> span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>list_queued_transactions_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionRefs/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classs2>a/span>span classp>,/span>span classw> /span>span classs2>b/span>span classp>,/span>span classw> /span>span classs2>c/span>span classp>,/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>Returns a list of transaction refs of transactions queued on a terminal.Details about the transactions can be retrieved using the Transaction StatusAPI./p>h2 iddelete-queued-transaction>Delete Queued Transaction/h2>blockquote>p>Delete Queued Transaction Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>delete-queue/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -txRefspan classo>/span>span classs2>*/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>delete-queue/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -txRefspan classo>/span>span classs2>*/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>deleteQueuedTransactionExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>DeleteQueuedTransactionRequest/span>span classp>{/span>span classx> /span>span classn>TerminalName/span>span classo>:/span>span classx> /span>span classs>Test Terminal/span>span classp>,/span>span classx> /span>span classn>TransactionRef/span>span classo>:/span>span classx> /span>span classs>*/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>DeleteQueuedTransaction/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>DeleteQueuedTransactionRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>DeleteQueuedTransactionRequest/span>span classp>{/span> span classn>TerminalName/span> span classp>/span> span classs>Test Terminal/span>span classp>,/span> span classn>TransactionRef/span> span classp>/span> span classs>*/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>DeleteQueuedTransactionResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>DeleteQueuedTransactionAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.DeleteQueuedTransactionRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.DeleteQueuedTransactionResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>DeleteQueuedTransactionExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>DeleteQueuedTransactionRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>DeleteQueuedTransactionRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTerminalName/span>span classo>(/span>span classs>Test Terminal/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setTransactionRef/span>span classo>(/span>span classs>*/span>span classo>);/span> span classc1>// Send the request/span> span classn>DeleteQueuedTransactionResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>deleteQueuedTransaction/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>terminalName/span> span classo>>/span> span classs1>Test Terminal/span>span classp>,/span> span classs1>transactionRef/span> span classo>>/span> span classs1>*/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>deleteQueuedTransaction/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>terminalName: /span>span classs1>Test Terminal/span>span classp>,/span> span classss>transactionRef: /span>span classs1>*/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>deleteQueuedTransaction/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>terminalName/span>span classp>:/span> span classs>Test Terminal/span>span classp>,/span> span classs>transactionRef/span>span classp>:/span> span classs>*/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>delete_queued_transaction/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>deleteQueuedTransaction/span>span classp>({/span> span classna>terminalName/span>span classp>:/span> span classs1>Test Terminal/span>span classp>,/span> span classna>transactionRef/span>span classp>:/span> span classs1>*/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>DeleteQueuedTransactionRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>terminalName/span> span classo>/span> span classs1>Test Terminal/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>transactionRef/span> span classo>/span> span classs1>*/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>deleteQueuedTransaction/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>DeleteQueuedTransactionResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>request/span>span classp>/span>span classs>transactionRef/span>span classp>/span> span classo>/span> span classs>*/span> span classp>/span>span classn>client/span> span classnf>deleteQueuedTransactionWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>request/span>span classp>/span>span classs>transactionRef/span>span classp>/span> span classo>/span> span classs>*/span> span classn>client/span>span classo>./span>span classnf>deleteQueuedTransaction/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>delete_queued_transaction_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classk>mut/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>DeleteQueuedTransactionRequest/span>span classp>{/span> span classn>terminal_name/span>span classp>:/span> span classs>Test Terminal/span>span classnf>.to_string/span>span classp>(),/span> span classn>transaction_ref/span>span classp>:/span> span classs>*/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.delete_queued_transaction/span>span classp>(/span>span classo>&/span>span classk>mut/span> span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>delete_queued_transaction_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>Deletes one or all queued transactions from a terminal. If code>*/code> is passed asa transaction ref, then the entire terminal queue will be cleared. An error isreturned if the passed transaction ref is not queued on the terminal./p>h1 idterminal-api>Terminal API/h1>p>These APIs support terminal management functions and additional terminal features such as line item display, messages, and interactive prompts.br>These features can be used to extend a point of sale system's functionality./p>h2 idterminal-ping>Terminal Ping/h2>blockquote>p>Terminal Ping Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>ping/span> -terminalspan classo>/span>span classs2>Test Terminal/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>ping/span> -terminalspan classo>/span>span classs2>Test Terminal/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>pingExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>PingRequest/span>span classp>{/span>span classx> /span>span classn>TerminalName/span>span classo>:/span>span classx> /span>span classs>Test Terminal/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>Ping/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>PingRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>PingRequest/span>span classp>{/span> span classn>TerminalName/span> span classp>/span> span classs>Test Terminal/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>PingResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>PingAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.PingRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.PingResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>PingExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>PingRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>PingRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTerminalName/span>span classo>(/span>span classs>Test Terminal/span>span classo>);/span> span classc1>// Send the request/span> span classn>PingResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>ping/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>terminalName/span> span classo>>/span> span classs1>Test Terminal/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>ping/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>terminalName: /span>span classs1>Test Terminal/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>ping/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>terminalName/span>span classp>:/span> span classs>Test Terminal/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>ping/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>ping/span>span classp>({/span> span classna>terminalName/span>span classp>:/span> span classs1>Test Terminal/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>PingRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>terminalName/span> span classo>/span> span classs1>Test Terminal/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>ping/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>PingResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classp>/span>span classn>client/span> span classnf>pingWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>client/span>span classo>./span>span classnf>ping/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>ping_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classk>mut/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>PingRequest/span>span classp>{/span> span classn>terminal_name/span>span classp>:/span> span classs>Test Terminal/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.ping/span>span classp>(/span>span classo>&/span>span classk>mut/span> span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>ping_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>ping/span>span classp>,/span>span classw> /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>tickBlock/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This simple test transaction helps ensure good communication with a payment terminal and is usually the first test you'll run in development./p>p>It tests communication with the terminal and returns a positive response if everythingis okay. It works the same way in local or cloud relay mode./p>p>If you get a positive response, you've successfully verified all of the following:/p>ul>li>The terminal is online./li>li>There is a valid route to the terminal./li>li>The API Credentials are valid./li>/ul>h2 idterminal-locate>Terminal Locate/h2>blockquote>p>Terminal Locate Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>locate/span> -terminalspan classo>/span>span classs2>Test Terminal/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>locate/span> -terminalspan classo>/span>span classs2>Test Terminal/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>locateExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>LocateRequest/span>span classp>{/span>span classx> /span>span classn>TerminalName/span>span classo>:/span>span classx> /span>span classs>Test Terminal/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>Locate/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>LocateRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>LocateRequest/span>span classp>{/span> span classn>TerminalName/span> span classp>/span> span classs>Test Terminal/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>LocateResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>LocateAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.LocateRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.LocateResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>LocateExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>LocateRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>LocateRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTerminalName/span>span classo>(/span>span classs>Test Terminal/span>span classo>);/span> span classc1>// Send the request/span> span classn>LocateResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>locate/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>terminalName/span> span classo>>/span> span classs1>Test Terminal/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>locate/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>terminalName: /span>span classs1>Test Terminal/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>locate/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>terminalName/span>span classp>:/span> span classs>Test Terminal/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>locate/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>locate/span>span classp>({/span> span classna>terminalName/span>span classp>:/span> span classs1>Test Terminal/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>LocateRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>terminalName/span> span classo>/span> span classs1>Test Terminal/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>locate/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>LocateResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classp>/span>span classn>client/span> span classnf>locateWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>client/span>span classo>./span>span classnf>locate/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>locate_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>LocateRequest/span>span classp>{/span> span classn>terminal_name/span>span classp>:/span> span classs>Test Terminal/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.locate/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>locate_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>errorMessage/span>span classp>:/span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>terminalName/span>span classp>:/span>span classw> /span>span classs2>Test Terminal/span>span classp>,/span>span classw> /span>span classs2>cloudRelay/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>ipAddress/span>span classp>:/span>span classw> /span>span classs2>127.0.0.1/span>span classp>,/span>span classw> /span>span classs2>publicKey/span>span classp>:/span>span classw> /span>span classs2>11pJMoWkjq1dHZcQp1P6apTk7J3QsoD9rtYW877c3BfJhDr8ozf/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This endpoint returns a terminal's routing and location information./p>p>The result will indicate whether or not the terminal is in cloud relay mode and willreturn the local IP address if the terminal is in local mode./p>p>The terminal will also return the public key for the terminal./p>h2 idterminal-clear>Terminal Clear/h2>blockquote>p>Terminal Clear Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>clear/span> -terminalspan classo>/span>span classs2>Test Terminal/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>clear/span> -terminalspan classo>/span>span classs2>Test Terminal/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>clearExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>ClearTerminalRequest/span>span classp>{/span>span classx> /span>span classn>Test/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classn>TerminalName/span>span classo>:/span>span classx> /span>span classs>Test Terminal/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>Clear/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>ClearTerminalRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>ClearTerminalRequest/span>span classp>{/span> span classn>Test/span> span classp>/span> span classk>true/span>span classp>,/span> span classn>TerminalName/span> span classp>/span> span classs>Test Terminal/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>Acknowledgement/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>ClearAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.ClearTerminalRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.Acknowledgement/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>ClearExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>ClearTerminalRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>ClearTerminalRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTest/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setTerminalName/span>span classo>(/span>span classs>Test Terminal/span>span classo>);/span> span classc1>// Send the request/span> span classn>Acknowledgement/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>clear/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>test/span> span classo>>/span> span classkc>true/span>span classp>,/span> span classs1>terminalName/span> span classo>>/span> span classs1>Test Terminal/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>clear/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>test: /span>span classkp>true/span>span classp>,/span> span classss>terminalName: /span>span classs1>Test Terminal/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>clear/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>test/span>span classp>:/span> span classbp>True/span>span classp>,/span> span classs>terminalName/span>span classp>:/span> span classs>Test Terminal/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>clear/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>clear/span>span classp>({/span> span classna>test/span>span classp>:/span> span classkc>true/span>span classp>,/span> span classna>terminalName/span>span classp>:/span> span classs1>Test Terminal/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>ClearTerminalRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>test/span> span classo>/span> span classkc>true/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>terminalName/span> span classo>/span> span classs1>Test Terminal/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>clear/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>Acknowledgement/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classnb>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classp>/span>span classn>client/span> span classnf>clearWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classkc>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>client/span>span classo>./span>span classnf>clear/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>clear_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classk>mut/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>ClearTerminalRequest/span>span classp>{/span> span classn>test/span>span classp>:/span> span classk>true/span>span classp>,/span> span classn>terminal_name/span>span classp>:/span> span classs>Test Terminal/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.clear/span>span classp>(/span>span classo>&/span>span classk>mut/span> span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>clear_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API interrupts whatever a terminal may be doing and returns it to theidle state./p>h2 idterminal-status>Terminal Status/h2>blockquote>p>Terminal Status Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>terminal-status/span> -terminalspan classo>/span>span classs2>Test Terminal/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>terminal-status/span> -terminalspan classo>/span>span classs2>Test Terminal/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>terminalStatusExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>TerminalStatusRequest/span>span classp>{/span>span classx> /span>span classn>TerminalName/span>span classo>:/span>span classx> /span>span classs>Test Terminal/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>TerminalStatus/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>TerminalStatusRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>TerminalStatusRequest/span>span classp>{/span> span classn>TerminalName/span> span classp>/span> span classs>Test Terminal/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>TerminalStatusResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>TerminalStatusAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TerminalStatusRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TerminalStatusResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>TerminalStatusExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>TerminalStatusRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>TerminalStatusRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTerminalName/span>span classo>(/span>span classs>Test Terminal/span>span classo>);/span> span classc1>// Send the request/span> span classn>TerminalStatusResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>terminalStatus/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>terminalName/span> span classo>>/span> span classs1>Test Terminal/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>terminalStatus/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>terminalName: /span>span classs1>Test Terminal/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>terminalStatus/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>terminalName/span>span classp>:/span> span classs>Test Terminal/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>terminal_status/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>terminalStatus/span>span classp>({/span> span classna>terminalName/span>span classp>:/span> span classs1>Test Terminal/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TerminalStatusRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>terminalName/span> span classo>/span> span classs1>Test Terminal/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>terminalStatus/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TerminalStatusResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classp>/span>span classn>client/span> span classnf>terminalStatusWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@idle/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@idle/span>span classp>)/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@status/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@status/span>span classp>)/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>client/span>span classo>./span>span classnf>terminalStatus/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classkt>NSLog/span>span classp>(/span>span classs>idle/span> span classo>+/span> span classs>: /span> span classo>+/span> span classp>(/span>span classn>response/span>span classp>/span>span classs>idle/span>span classp>/span> span classk>as?/span> span classkt>String/span>span classp>)/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classkt>NSLog/span>span classp>(/span>span classs>status/span> span classo>+/span> span classs>: /span> span classo>+/span> span classp>(/span>span classn>response/span>span classp>/span>span classs>status/span>span classp>/span> span classk>as?/span> span classkt>String/span>span classp>)/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>terminal_status_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classk>mut/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>TerminalStatusRequest/span>span classp>{/span> span classn>terminal_name/span>span classp>:/span> span classs>Test Terminal/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.terminal_status/span>span classp>(/span>span classo>&/span>span classk>mut/span> span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>terminal_status_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>idle/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>cardInSlot/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>charge/span>span classp>,/span>span classw> /span>span classs2>transactionRef/span>span classp>:/span>span classw> /span>span classs2>MYTXREF/span>span classp>,/span>span classw> /span>span classs2>since/span>span classp>:/span>span classw> /span>span classs2>2020-05-01T22:26:08.54243745Z/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API returns the current status of a payment terminal. This is typically usedas a way to determine if the terminal is busy before sending a new transaction./p>p>If the terminal is busy, code>idle/code> will be false and the code>status/code> field will returna short string that indicates the transaction type currently in progress. The systemwill also return the timestamp of the last status change in the code>since/code> field./p>p>The code>cardInSlot/code> field in the response will indicates whether or not a card is currently in the card reader slot./p>p>If the system is running a payment transaction and you wisely passed in aTransaction Ref, this API will also return the Transaction Ref of the in progresstransaction./p>p>The table below lists all possible status responses./p>table>thead>tr>th>Status Code/th>th>Description/th>/tr>/thead>tbody>tr>td>idle/td>td>The terminal is idle and ready for transactions. The default branding is being displayed./td>/tr>tr>td>activate/td>td>The terminal is in the process of activating and pairing with the merchant account./td>/tr>tr>td>balance/td>td>A balance check (EBT or Gift Card) is pending on the terminal./td>/tr>tr>td>boolean-prompt/td>td>A boolean prompt (yes/no) operation is pending on the terminal./td>/tr>tr>td>signature/td>td>A signature capture is pending./td>/tr>tr>td>crypto/td>td>A cryptocurrency transaction is pending./td>/tr>tr>td>enroll/td>td>A token vault enrollment operation is pending./td>/tr>tr>td>gift-activate/td>td>A gift card activation operation is in progress./td>/tr>tr>td>message/td>td>The terminal is displaying a custom message./td>/tr>tr>td>charge/td>td>The terminal is executing a charge transaction./td>/tr>tr>td>preauth/td>td>The terminal is executing a preauth transaction./td>/tr>tr>td>refund/td>td>The terminal is executing a refund transaction./td>/tr>tr>td>survey/td>td>The terminal is displaying post transaction survey questions./td>/tr>tr>td>terms-and-conditions/td>td>The terminal is pending terms and conditions acceptance and signature./td>/tr>tr>td>text-prompt/td>td>The terminal is awaiting response to a text input prompt./td>/tr>tr>td>txdisplay/td>td>The terminal is displaying transaction and/or line item level details./td>/tr>/tbody>/table>h2 idcapture-signature>Capture Signature/h2>blockquote>p>Capture Signature Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>capture-signature/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -sigFormatspan classo>/span>span classs2>png/span> -sigWidthspan classo>/span>span classs2>400/span> -sigFilespan classo>/span>span classs2>sig.png/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>capture-signature/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -sigFormatspan classo>/span>span classs2>png/span> -sigWidthspan classo>/span>span classs2>400/span> -sigFilespan classo>/span>span classs2>sig.png/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>captureSignatureExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>CaptureSignatureRequest/span>span classp>{/span>span classx> /span>span classn>TerminalName/span>span classo>:/span>span classx> /span>span classs>Test Terminal/span>span classp>,/span>span classx> /span>span classc>// file format for the signature image./span>span classx> /span>span classn>SigFormat/span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>SignatureFormatPNG/span>span classp>,/span>span classx> /span>span classc>// width of the signature image in pixels./span>span classx> /span>span classn>SigWidth/span>span classo>:/span>span classx> /span>span classm>200/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>CaptureSignature/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>CaptureSignatureRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>CaptureSignatureRequest/span>span classp>{/span> span classn>TerminalName/span> span classp>/span> span classs>Test Terminal/span>span classp>,/span> span classn>SigFormat/span> span classp>/span> span classn>SignatureFormat/span>span classp>./span>span classn>PNG/span>span classp>,/span> span classn>SigWidth/span> span classp>/span> span classm>200/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>CaptureSignatureResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>CaptureSignatureAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.CaptureSignatureRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.CaptureSignatureResponse/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.SignatureFormat/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>CaptureSignatureExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>CaptureSignatureRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>CaptureSignatureRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTerminalName/span>span classo>(/span>span classs>Test Terminal/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setSigFormat/span>span classo>(/span>span classn>SignatureFormat/span>span classo>./span>span classna>PNG/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setSigWidth/span>span classo>(/span>span classmi>200/span>span classo>);/span> span classc1>// Send the request/span> span classn>CaptureSignatureResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>captureSignature/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>terminalName/span> span classo>>/span> span classs1>Test Terminal/span>span classp>,/span> span classc1>// File format for the signature image./span> span classs1>sigFormat/span> span classo>>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>SIGNATURE_FORMAT_PNG/span>span classp>,/span> span classc1>// Width of the signature image in pixels./span> span classs1>sigWidth/span> span classo>>/span> span classmi>200/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>captureSignature/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>terminalName: /span>span classs1>Test Terminal/span>span classp>,/span> span classc1># File format for the signature image./span> span classss>sigFormat: /span>span classno>SignatureFormat/span>span classo>::/span>span classno>PNG/span>span classp>,/span> span classc1># Width of the signature image in pixels./span> span classss>sigWidth: /span>span classmi>200/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>captureSignature/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>terminalName/span>span classp>:/span> span classs>Test Terminal/span>span classp>,/span> span classc># File format for the signature image./span> span classs>sigFormat/span>span classp>:/span> span classn>blockchyp/span>span classo>./span>span classn>SignatureFormat/span>span classo>./span>span classn>PNG/span>span classp>,/span> span classc># Width of the signature image in pixels./span> span classs>sigWidth/span>span classp>:/span> span classmi>200/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>capture_signature/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>captureSignature/span>span classp>({/span> span classna>terminalName/span>span classp>:/span> span classs1>Test Terminal/span>span classp>,/span> span classc1>// File format for the signature image./span> span classna>sigFormat/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>SignatureFormat/span>span classp>./span>span classnx>PNG/span>span classp>,/span> span classc1>// Width of the signature image in pixels./span> span classna>sigWidth/span>span classp>:/span> span classmi>200/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>CaptureSignatureRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>terminalName/span> span classo>/span> span classs1>Test Terminal/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>sigFormat/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>SignatureFormat/span>span classp>./span>span classnx>PNG/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>sigWidth/span> span classo>/span> span classmi>200/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>captureSignature/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>CaptureSignatureResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>request/span>span classp>/span>span classs>sigFormat/span>span classp>/span> span classo>/span> span classn>SIGNATURE_FORMAT_PNG/span> span classn>request/span>span classp>/span>span classs>sigWidth/span>span classp>/span> span classo>/span> span classmi>200/span> span classp>/span>span classn>client/span> span classnf>captureSignatureWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>request/span>span classp>/span>span classs>sigFormat/span>span classp>/span> span classo>/span> span classkt>SIGNATURE_FORMAT_PNG/span> span classn>request/span>span classp>/span>span classs>sigWidth/span>span classp>/span> span classo>/span> span classmi>200/span> span classn>client/span>span classo>./span>span classnf>captureSignature/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>capture_signature_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classk>mut/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>CaptureSignatureRequest/span>span classp>{/span> span classn>terminal_name/span>span classp>:/span> span classs>Test Terminal/span>span classnf>.to_string/span>span classp>(),/span> span classn>sig_format/span>span classp>:/span> span classnn>blockchyp/span>span classp>::/span>span classnn>SignatureFormat/span>span classp>::/span>span classn>PNG/span>span classp>,/span> span classn>sig_width/span>span classp>:/span> span classmi>200/span>span classp>,/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.capture_signature/span>span classp>(/span>span classo>&/span>span classk>mut/span> span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>capture_signature_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This endpoint captures a written signature from the terminal and returns theimage./p>p>Unlike the Terms & Conditions API, this endpoint performs basic signaturecapture with no agreement display or signature archival./p>p>Under the hood, signatures are captured in a proprietary vector format andmust be converted to a common raster format in order to be useful to mostapplications. At a minimum, you must specify an image format using thecode>sigFormat/code> parameter. Currently, JPG and PNG are supported./p>p>By default, images are returned in the JSON response as hex encoded binary.You can redirect the binary image output to a file using the code>sigFile/code>parameter./p>p>You can also scale the output image to your preferred width bypassing in a code>sigWidth/code> parameter. The image will be scaled to thatwidth, preserving the aspect ratio of the original image./p>aside classinfo>This example shows the most common use case of exporting a scaled PNG image toa file, but there are other options. Check out the section below on Working With Signatures for moredetail on signature handling and options./aside>h2 idnew-transaction-display>New Transaction Display/h2>blockquote>p>New Transaction Display Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>display/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -displaySubtotalspan classo>/span>span classs2>120.05/span> -displayTaxspan classo>/span>span classs2>5.00/span> -displayTotalspan classo>/span>span classs2>125.05/span> -lineItemDescriptionspan classo>/span>span classs2>Leki Trekking Poles/span> -lineItemQtyspan classo>/span>span classs2>1/span> -lineItemPricespan classo>/span>span classs2>135.05/span> -lineItemDiscountDescriptionspan classo>/span>span classs2>Member Discount/span> -lineItemDiscountAmountspan classo>/span>span classs2>10.00/span> -lineItemExtendedspan classo>/span>span classs2>120.05/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>display/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -displaySubtotalspan classo>/span>span classs2>120.05/span> -displayTaxspan classo>/span>span classs2>5.00/span> -displayTotalspan classo>/span>span classs2>125.05/span> -lineItemDescriptionspan classo>/span>span classs2>Leki Trekking Poles/span> -lineItemQtyspan classo>/span>span classs2>1/span> -lineItemPricespan classo>/span>span classs2>135.05/span> -lineItemDiscountDescriptionspan classo>/span>span classs2>Member Discount/span> -lineItemDiscountAmountspan classo>/span>span classs2>10.00/span> -lineItemExtendedspan classo>/span>span classs2>120.05/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>newTransactionDisplayExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>TransactionDisplayRequest/span>span classp>{/span>span classx> /span>span classn>Test/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classn>TerminalName/span>span classo>:/span>span classx> /span>span classs>Test Terminal/span>span classp>,/span>span classx> /span>span classn>Transaction/span>span classo>:/span>span classx> /span>span classo>&/span>span classn>blockchyp/span>span classo>./span>span classn>TransactionDisplayTransaction/span>span classp>{/span>span classx> /span>span classn>Subtotal/span>span classo>:/span>span classx> /span>span classs>60.00/span>span classp>,/span>span classx> /span>span classn>Tax/span>span classo>:/span>span classx> /span>span classs>5.00/span>span classp>,/span>span classx> /span>span classn>Total/span>span classo>:/span>span classx> /span>span classs>65.00/span>span classp>,/span>span classx> /span>span classn>Items/span>span classo>:/span>span classx> /span>span classp>/span>span classo>*/span>span classn>blockchyp/span>span classo>./span>span classn>TransactionDisplayItem/span>span classp>{/span>span classx> /span>span classo>&/span>span classn>blockchyp/span>span classo>./span>span classn>TransactionDisplayItem/span>span classp>{/span>span classx> /span>span classn>Description/span>span classo>:/span>span classx> /span>span classs>Leki Trekking Poles/span>span classp>,/span>span classx> /span>span classn>Price/span>span classo>:/span>span classx> /span>span classs>35.00/span>span classp>,/span>span classx> /span>span classn>Quantity/span>span classo>:/span>span classx> /span>span classm>2/span>span classp>,/span>span classx> /span>span classn>Extended/span>span classo>:/span>span classx> /span>span classs>70.00/span>span classp>,/span>span classx> /span>span classn>Discounts/span>span classo>:/span>span classx> /span>span classp>/span>span classo>*/span>span classn>blockchyp/span>span classo>./span>span classn>TransactionDisplayDiscount/span>span classp>{/span>span classx> /span>span classo>&/span>span classn>blockchyp/span>span classo>./span>span classn>TransactionDisplayDiscount/span>span classp>{/span>span classx> /span>span classn>Description/span>span classo>:/span>span classx> /span>span classs>memberDiscount/span>span classp>,/span>span classx> /span>span classn>Amount/span>span classo>:/span>span classx> /span>span classs>10.00/span>span classp>,/span>span classx> /span>span classp>},/span>span classx> /span>span classp>},/span>span classx> /span>span classp>},/span>span classx> /span>span classp>},/span>span classx> /span>span classp>},/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>NewTransactionDisplay/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>TransactionDisplayRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>TransactionDisplayRequest/span>span classp>{/span> span classn>Test/span> span classp>/span> span classk>true/span>span classp>,/span> span classn>TerminalName/span> span classp>/span> span classs>Test Terminal/span>span classp>,/span> span classn>Transaction/span> span classp>/span> span classk>new/span> span classn>TransactionDisplayTransaction/span> span classp>{/span> span classn>Subtotal/span> span classp>/span> span classs>60.00/span>span classp>,/span> span classn>Tax/span> span classp>/span> span classs>5.00/span>span classp>,/span> span classn>Total/span> span classp>/span> span classs>65.00/span>span classp>,/span> span classn>Items/span> span classp>/span> span classk>new/span> span classn>List/span>span classp>span classn>TransactionDisplayItem/span>span classp>>/span> span classp>{/span> span classk>new/span> span classn>TransactionDisplayItem/span> span classp>{/span> span classn>Description/span> span classp>/span> span classs>Leki Trekking Poles/span>span classp>,/span> span classn>Price/span> span classp>/span> span classs>35.00/span>span classp>,/span> span classn>Quantity/span> span classp>/span> span classm>2/span>span classp>,/span> span classn>Extended/span> span classp>/span> span classs>70.00/span>span classp>,/span> span classn>Discounts/span> span classp>/span> span classk>new/span> span classn>List/span>span classp>span classn>TransactionDisplayDiscount/span>span classp>>/span> span classp>{/span> span classk>new/span> span classn>TransactionDisplayDiscount/span> span classp>{/span> span classn>Description/span> span classp>/span> span classs>memberDiscount/span>span classp>,/span> span classn>Amount/span> span classp>/span> span classs>10.00/span>span classp>,/span> span classp>}/span> span classp>},/span> span classp>}/span> span classp>},/span> span classp>},/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>Acknowledgement/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>NewTransactionDisplayAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TransactionDisplayRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.Acknowledgement/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TransactionDisplayTransaction/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TransactionDisplayItem/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TransactionDisplayDiscount/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>NewTransactionDisplayExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>TransactionDisplayRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>TransactionDisplayRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTest/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setTerminalName/span>span classo>(/span>span classs>Test Terminal/span>span classo>);/span> span classn>TransactionDisplayTransaction/span> span classn>transaction/span> span classo>/span> span classk>new/span> span classn>TransactionDisplayTransaction/span>span classo>();/span> span classn>transaction/span>span classo>./span>span classna>setSubtotal/span>span classo>(/span>span classs>60.00/span>span classo>);/span> span classn>transaction/span>span classo>./span>span classna>setTax/span>span classo>(/span>span classs>5.00/span>span classo>);/span> span classn>transaction/span>span classo>./span>span classna>setTotal/span>span classo>(/span>span classs>65.00/span>span classo>);/span> span classn>Collection/span> span classn>items/span> span classo>/span> span classk>new/span> span classn>ArrayList/span>span classo>();/span> span classn>TransactionDisplayItem/span> span classn>items0/span> span classo>/span> span classk>new/span> span classn>TransactionDisplayItem/span>span classo>();/span> span classn>items0/span>span classo>./span>span classna>setDescription/span>span classo>(/span>span classs>Leki Trekking Poles/span>span classo>);/span> span classn>items0/span>span classo>./span>span classna>setPrice/span>span classo>(/span>span classs>35.00/span>span classo>);/span> span classn>items0/span>span classo>./span>span classna>setQuantity/span>span classo>(/span>span classmi>2/span>span classo>);/span> span classn>items0/span>span classo>./span>span classna>setExtended/span>span classo>(/span>span classs>70.00/span>span classo>);/span> span classn>Collection/span> span classn>discounts/span> span classo>/span> span classk>new/span> span classn>ArrayList/span>span classo>();/span> span classn>TransactionDisplayDiscount/span> span classn>discounts0/span> span classo>/span> span classk>new/span> span classn>TransactionDisplayDiscount/span>span classo>();/span> span classn>discounts0/span>span classo>./span>span classna>setDescription/span>span classo>(/span>span classs>memberDiscount/span>span classo>);/span> span classn>discounts0/span>span classo>./span>span classna>setAmount/span>span classo>(/span>span classs>10.00/span>span classo>);/span> span classn>discounts/span>span classo>./span>span classna>add/span>span classo>(/span>span classn>discounts0/span>span classo>);/span> span classn>items0/span>span classo>./span>span classna>setDiscounts/span>span classo>(/span>span classn>discounts/span>span classo>);/span> span classn>items/span>span classo>./span>span classna>add/span>span classo>(/span>span classn>items0/span>span classo>);/span> span classn>transaction/span>span classo>./span>span classna>setItems/span>span classo>(/span>span classn>items/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setTransaction/span>span classo>(/span>span classn>transaction/span>span classo>);/span> span classc1>// Send the request/span> span classn>Acknowledgement/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>newTransactionDisplay/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>test/span> span classo>>/span> span classkc>true/span>span classp>,/span> span classs1>terminalName/span> span classo>>/span> span classs1>Test Terminal/span>span classp>,/span> span classs1>transaction/span> span classo>>/span> span classp>/span> span classs1>subtotal/span> span classo>>/span> span classs1>60.00/span>span classp>,/span> span classs1>tax/span> span classo>>/span> span classs1>5.00/span>span classp>,/span> span classs1>total/span> span classo>>/span> span classs1>65.00/span>span classp>,/span> span classs1>items/span> span classo>>/span> span classp>/span> span classp>/span> span classs1>description/span> span classo>>/span> span classs1>Leki Trekking Poles/span>span classp>,/span> span classs1>price/span> span classo>>/span> span classs1>35.00/span>span classp>,/span> span classs1>quantity/span> span classo>>/span> span classmi>2/span>span classp>,/span> span classs1>extended/span> span classo>>/span> span classs1>70.00/span>span classp>,/span> span classs1>discounts/span> span classo>>/span> span classp>/span> span classp>/span> span classs1>description/span> span classo>>/span> span classs1>memberDiscount/span>span classp>,/span> span classs1>amount/span> span classo>>/span> span classs1>10.00/span>span classp>,/span> span classp>,/span> span classp>,/span> span classp>,/span> span classp>,/span> span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>newTransactionDisplay/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>test: /span>span classkp>true/span>span classp>,/span> span classss>terminalName: /span>span classs1>Test Terminal/span>span classp>,/span> span classss>transaction: /span>span classp>{/span> span classss>subtotal: /span>span classs1>60.00/span>span classp>,/span> span classss>tax: /span>span classs1>5.00/span>span classp>,/span> span classss>total: /span>span classs1>65.00/span>span classp>,/span> span classss>items: /span>span classp>/span> span classp>{/span> span classss>description: /span>span classs1>Leki Trekking Poles/span>span classp>,/span> span classss>price: /span>span classs1>35.00/span>span classp>,/span> span classss>quantity: /span>span classmi>2/span>span classp>,/span> span classss>extended: /span>span classs1>70.00/span>span classp>,/span> span classss>discounts: /span>span classp>/span> span classp>{/span> span classss>description: /span>span classs1>memberDiscount/span>span classp>,/span> span classss>amount: /span>span classs1>10.00/span> span classp>}/span> span classp>/span> span classp>}/span> span classp>/span> span classp>}/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>newTransactionDisplay/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>test/span>span classp>:/span> span classbp>True/span>span classp>,/span> span classs>terminalName/span>span classp>:/span> span classs>Test Terminal/span>span classp>,/span> span classs>transaction/span>span classp>:/span> span classp>{/span> span classs>subtotal/span>span classp>:/span> span classs>60.00/span>span classp>,/span> span classs>tax/span>span classp>:/span> span classs>5.00/span>span classp>,/span> span classs>total/span>span classp>:/span> span classs>65.00/span>span classp>,/span> span classs>items/span>span classp>:/span> span classp>/span> span classp>{/span> span classs>description/span>span classp>:/span> span classs>Leki Trekking Poles/span>span classp>,/span> span classs>price/span>span classp>:/span> span classs>35.00/span>span classp>,/span> span classs>quantity/span>span classp>:/span> span classmi>2/span>span classp>,/span> span classs>extended/span>span classp>:/span> span classs>70.00/span>span classp>,/span> span classs>discounts/span>span classp>:/span> span classp>/span> span classp>{/span> span classs>description/span>span classp>:/span> span classs>memberDiscount/span>span classp>,/span> span classs>amount/span>span classp>:/span> span classs>10.00/span>span classp>,/span> span classp>},/span> span classp>,/span> span classp>},/span> span classp>,/span> span classp>},/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>new_transaction_display/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>newTransactionDisplay/span>span classp>({/span> span classna>test/span>span classp>:/span> span classkc>true/span>span classp>,/span> span classna>terminalName/span>span classp>:/span> span classs1>Test Terminal/span>span classp>,/span> span classna>transaction/span>span classp>:/span> span classp>{/span> span classna>subtotal/span>span classp>:/span> span classs1>60.00/span>span classp>,/span> span classna>tax/span>span classp>:/span> span classs1>5.00/span>span classp>,/span> span classna>total/span>span classp>:/span> span classs1>65.00/span>span classp>,/span> span classna>items/span>span classp>:/span> span classp>/span> span classp>{/span> span classna>description/span>span classp>:/span> span classs1>Leki Trekking Poles/span>span classp>,/span> span classna>price/span>span classp>:/span> span classs1>35.00/span>span classp>,/span> span classna>quantity/span>span classp>:/span> span classmi>2/span>span classp>,/span> span classna>extended/span>span classp>:/span> span classs1>70.00/span>span classp>,/span> span classna>discounts/span>span classp>:/span> span classp>/span> span classp>{/span> span classna>description/span>span classp>:/span> span classs1>memberDiscount/span>span classp>,/span> span classna>amount/span>span classp>:/span> span classs1>10.00/span>span classp>,/span> span classp>},/span> span classp>,/span> span classp>},/span> span classp>,/span> span classp>},/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TransactionDisplayRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>test/span> span classo>/span> span classkc>true/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>terminalName/span> span classo>/span> span classs1>Test Terminal/span>span classp>;/span>span classkd>const/span> span classnx>transaction/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TransactionDisplayTransaction/span>span classp>();/span>span classnx>transaction/span>span classp>./span>span classnx>subtotal/span> span classo>/span> span classs1>60.00/span>span classp>;/span>span classnx>transaction/span>span classp>./span>span classnx>tax/span> span classo>/span> span classs1>5.00/span>span classp>;/span>span classnx>transaction/span>span classp>./span>span classnx>total/span> span classo>/span> span classs1>65.00/span>span classp>;/span>span classkd>const/span> span classnx>items/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TransactionDisplayItem/span>span classp>();/span>span classnx>items/span>span classp>./span>span classnx>description/span> span classo>/span> span classs1>Leki Trekking Poles/span>span classp>;/span>span classnx>items/span>span classp>./span>span classnx>price/span> span classo>/span> span classs1>35.00/span>span classp>;/span>span classnx>items/span>span classp>./span>span classnx>quantity/span> span classo>/span> span classmi>2/span>span classp>;/span>span classnx>items/span>span classp>./span>span classnx>extended/span> span classo>/span> span classs1>70.00/span>span classp>;/span>span classkd>const/span> span classnx>discounts/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TransactionDisplayDiscount/span>span classp>();/span>span classnx>discounts/span>span classp>./span>span classnx>description/span> span classo>/span> span classs1>memberDiscount/span>span classp>;/span>span classnx>discounts/span>span classp>./span>span classnx>amount/span> span classo>/span> span classs1>10.00/span>span classp>;/span>span classnx>items/span>span classp>./span>span classnx>discounts/span> span classo>/span> span classp>/span>span classnx>discounts/span>span classp>;/span>span classnx>transaction/span>span classp>./span>span classnx>items/span> span classo>/span> span classp>/span>span classnx>items/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>transaction/span> span classo>/span> span classnx>transaction/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>newTransactionDisplay/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>Acknowledgement/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classnb>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>var/span> span classn>transaction/span>span classo>:/span> span classp>/span>span classnf>String/span>span classp>:/span>span classn>Any/span>span classp>/span> span classo>/span> span classp>/span>span classo>:/span>span classp>/span> span classn>transaction/span>span classp>/span>span classs>subtotal/span>span classp>/span> span classo>/span> span classs>60.00/span> span classn>transaction/span>span classp>/span>span classs>tax/span>span classp>/span> span classo>/span> span classs>5.00/span> span classn>transaction/span>span classp>/span>span classs>total/span>span classp>/span> span classo>/span> span classs>65.00/span> span classn>var/span> span classn>items/span> span classo>/span> span classp>/span>span classnf>Any/span>span classp>();/span> span classn>var/span> span classn>items1/span>span classo>:/span> span classp>/span>span classnf>String/span>span classp>:/span>span classn>Any/span>span classp>/span> span classo>/span> span classp>/span>span classo>:/span>span classp>/span> span classn>items1/span>span classp>/span>span classs>description/span>span classp>/span> span classo>/span> span classs>Leki Trekking Poles/span> span classn>items1/span>span classp>/span>span classs>price/span>span classp>/span> span classo>/span> span classs>35.00/span> span classn>items1/span>span classp>/span>span classs>quantity/span>span classp>/span> span classo>/span> span classmi>2/span> span classn>items1/span>span classp>/span>span classs>extended/span>span classp>/span> span classo>/span> span classs>70.00/span> span classn>var/span> span classn>discounts/span> span classo>/span> span classp>/span>span classnf>Any/span>span classp>();/span> span classn>var/span> span classn>discounts1/span>span classo>:/span> span classp>/span>span classnf>String/span>span classp>:/span>span classn>Any/span>span classp>/span> span classo>/span> span classp>/span>span classo>:/span>span classp>/span> span classn>discounts1/span>span classp>/span>span classs>description/span>span classp>/span> span classo>/span> span classs>memberDiscount/span> span classn>discounts1/span>span classp>/span>span classs>amount/span>span classp>/span> span classo>/span> span classs>10.00/span> span classn>discounts/span>span classp>./span>span classn>append/span>span classp>(/span>span classn>discounts1/span>span classp>)/span> span classn>items1/span>span classp>/span>span classs>discounts/span>span classp>/span> span classo>/span> span classn>discounts/span> span classn>items/span>span classp>./span>span classn>append/span>span classp>(/span>span classn>items1/span>span classp>)/span> span classn>transaction/span>span classp>/span>span classs>items/span>span classp>/span> span classo>/span> span classn>items/span> span classn>request/span>span classp>/span>span classs>transaction/span>span classp>/span> span classo>/span> span classn>transaction/span> span classp>/span>span classn>client/span> span classnf>newTransactionDisplayWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classkc>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classk>var/span> span classnv>transaction/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>transaction/span>span classp>/span>span classs>subtotal/span>span classp>/span> span classo>/span> span classs>60.00/span> span classn>transaction/span>span classp>/span>span classs>tax/span>span classp>/span> span classo>/span> span classs>5.00/span> span classn>transaction/span>span classp>/span>span classs>total/span>span classp>/span> span classo>/span> span classs>65.00/span> span classk>var/span> span classnv>items/span> span classo>/span> span classp>/span>span classkt>Any/span>span classp>();/span> span classk>var/span> span classnv>items1/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>items1/span>span classp>/span>span classs>description/span>span classp>/span> span classo>/span> span classs>Leki Trekking Poles/span> span classn>items1/span>span classp>/span>span classs>price/span>span classp>/span> span classo>/span> span classs>35.00/span> span classn>items1/span>span classp>/span>span classs>quantity/span>span classp>/span> span classo>/span> span classmi>2/span> span classn>items1/span>span classp>/span>span classs>extended/span>span classp>/span> span classo>/span> span classs>70.00/span> span classk>var/span> span classnv>discounts/span> span classo>/span> span classp>/span>span classkt>Any/span>span classp>();/span> span classk>var/span> span classnv>discounts1/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>discounts1/span>span classp>/span>span classs>description/span>span classp>/span> span classo>/span> span classs>memberDiscount/span> span classn>discounts1/span>span classp>/span>span classs>amount/span>span classp>/span> span classo>/span> span classs>10.00/span> span classn>discounts/span>span classo>./span>span classnf>append/span>span classp>(/span>span classn>discounts1/span>span classp>)/span> span classn>items1/span>span classp>/span>span classs>discounts/span>span classp>/span> span classo>/span> span classn>discounts/span> span classn>items/span>span classo>./span>span classnf>append/span>span classp>(/span>span classn>items1/span>span classp>)/span> span classn>transaction/span>span classp>/span>span classs>items/span>span classp>/span> span classo>/span> span classn>items/span> span classn>request/span>span classp>/span>span classs>transaction/span>span classp>/span> span classo>/span> span classn>transaction/span> span classn>client/span>span classo>./span>span classnf>newTransactionDisplay/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>new_transaction_display_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classk>mut/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>TransactionDisplayRequest/span>span classp>{/span> span classn>test/span>span classp>:/span> span classk>true/span>span classp>,/span> span classn>terminal_name/span>span classp>:/span> span classs>Test Terminal/span>span classnf>.to_string/span>span classp>(),/span> span classn>transaction/span>span classp>:/span> span classnf>Some/span>span classp>(/span>span classnn>blockchyp/span>span classp>::/span>span classn>TransactionDisplayTransaction/span>span classp>{/span> span classn>subtotal/span>span classp>:/span> span classs>60.00/span>span classnf>.to_string/span>span classp>(),/span> span classn>tax/span>span classp>:/span> span classs>5.00/span>span classnf>.to_string/span>span classp>(),/span> span classn>total/span>span classp>:/span> span classs>65.00/span>span classnf>.to_string/span>span classp>(),/span> span classn>items/span>span classp>:/span> span classnf>Some/span>span classp>(/span>span classnd>vec!/span>span classp>/span> span classnn>blockchyp/span>span classp>::/span>span classn>TransactionDisplayItem/span>span classp>{/span> span classn>description/span>span classp>:/span> span classs>Leki Trekking Poles/span>span classnf>.to_string/span>span classp>(),/span> span classn>price/span>span classp>:/span> span classs>35.00/span>span classnf>.to_string/span>span classp>(),/span> span classn>quantity/span>span classp>:/span> span classmf>2.0/span>span classp>,/span> span classn>extended/span>span classp>:/span> span classs>70.00/span>span classnf>.to_string/span>span classp>(),/span> span classn>discounts/span>span classp>:/span> span classnf>Some/span>span classp>(/span>span classnd>vec!/span>span classp>/span> span classnn>blockchyp/span>span classp>::/span>span classn>TransactionDisplayDiscount/span>span classp>{/span> span classn>description/span>span classp>:/span> span classs>memberDiscount/span>span classnf>.to_string/span>span classp>(),/span> span classn>amount/span>span classp>:/span> span classs>10.00/span>span classnf>.to_string/span>span classp>(),/span> .span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>},/span> span classp>),/span> .span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>},/span> span classp>),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>}),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.new_transaction_display/span>span classp>(/span>span classo>&/span>span classk>mut/span> span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>new_transaction_display_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API sends totals and line item level data to the terminal./p>p>At a minimum, you should send total information as part of a display request,including code>total/code>, code>tax/code>, and code>subtotal/code>./p>p>You can also send line item level data and each line item can have a code>description/code>,code>qty/code>, code>price/code>, and code>extended/code> price./p>p>If you fail to send an extended price, BlockChyp will multiply the code>qty/code> by thecode>price/code>. However, we strongly recommend you precalculate all the fields yourselfto ensure consistency. For example, your treatment of floating-point multiplication and rounding may differ slightly from BlockChyp's./p>p>strong>Discounts/strong>/p>p>You have the option to show discounts on the display as individual line itemswith negative values or you can associate discounts with a specific line item.You can apply any number of discounts to an individual line item with a descriptionand amount./p>aside classinfo>There are two methods of sending line item level data to a terminal for customer display. Thisversion removes and replaces any line item level data that may be on the terminal./aside>aside classsuccess>b>Level III Processing/b>p>If line item display is used, any subsequent payment transaction will submit themost recent line item information for Level III processing. This may reduceinterchange fees for some merchants./p>/aside>h2 idupdate-transaction-display>Update Transaction Display/h2>blockquote>p>Update Transaction Display Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>display/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -displaySubtotalspan classo>/span>span classs2>120.05/span> -displayTaxspan classo>/span>span classs2>5.00/span> -displayTotalspan classo>/span>span classs2>125.05/span> -lineItemDescriptionspan classo>/span>span classs2>Leki Trekking Poles/span> -lineItemQtyspan classo>/span>span classs2>1/span> -lineItemPricespan classo>/span>span classs2>135.05/span> -lineItemDiscountDescriptionspan classo>/span>span classs2>Member Discount/span> -lineItemDiscountAmountspan classo>/span>span classs2>10.00/span> -lineItemExtendedspan classo>/span>span classs2>120.05/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>display/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -displaySubtotalspan classo>/span>span classs2>120.05/span> -displayTaxspan classo>/span>span classs2>5.00/span> -displayTotalspan classo>/span>span classs2>125.05/span> -lineItemDescriptionspan classo>/span>span classs2>Leki Trekking Poles/span> -lineItemQtyspan classo>/span>span classs2>1/span> -lineItemPricespan classo>/span>span classs2>135.05/span> -lineItemDiscountDescriptionspan classo>/span>span classs2>Member Discount/span> -lineItemDiscountAmountspan classo>/span>span classs2>10.00/span> -lineItemExtendedspan classo>/span>span classs2>120.05/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>updateTransactionDisplayExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>TransactionDisplayRequest/span>span classp>{/span>span classx> /span>span classn>Test/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classn>TerminalName/span>span classo>:/span>span classx> /span>span classs>Test Terminal/span>span classp>,/span>span classx> /span>span classn>Transaction/span>span classo>:/span>span classx> /span>span classo>&/span>span classn>blockchyp/span>span classo>./span>span classn>TransactionDisplayTransaction/span>span classp>{/span>span classx> /span>span classn>Subtotal/span>span classo>:/span>span classx> /span>span classs>60.00/span>span classp>,/span>span classx> /span>span classn>Tax/span>span classo>:/span>span classx> /span>span classs>5.00/span>span classp>,/span>span classx> /span>span classn>Total/span>span classo>:/span>span classx> /span>span classs>65.00/span>span classp>,/span>span classx> /span>span classn>Items/span>span classo>:/span>span classx> /span>span classp>/span>span classo>*/span>span classn>blockchyp/span>span classo>./span>span classn>TransactionDisplayItem/span>span classp>{/span>span classx> /span>span classo>&/span>span classn>blockchyp/span>span classo>./span>span classn>TransactionDisplayItem/span>span classp>{/span>span classx> /span>span classn>Description/span>span classo>:/span>span classx> /span>span classs>Leki Trekking Poles/span>span classp>,/span>span classx> /span>span classn>Price/span>span classo>:/span>span classx> /span>span classs>35.00/span>span classp>,/span>span classx> /span>span classn>Quantity/span>span classo>:/span>span classx> /span>span classm>2/span>span classp>,/span>span classx> /span>span classn>Extended/span>span classo>:/span>span classx> /span>span classs>70.00/span>span classp>,/span>span classx> /span>span classn>Discounts/span>span classo>:/span>span classx> /span>span classp>/span>span classo>*/span>span classn>blockchyp/span>span classo>./span>span classn>TransactionDisplayDiscount/span>span classp>{/span>span classx> /span>span classo>&/span>span classn>blockchyp/span>span classo>./span>span classn>TransactionDisplayDiscount/span>span classp>{/span>span classx> /span>span classn>Description/span>span classo>:/span>span classx> /span>span classs>memberDiscount/span>span classp>,/span>span classx> /span>span classn>Amount/span>span classo>:/span>span classx> /span>span classs>10.00/span>span classp>,/span>span classx> /span>span classp>},/span>span classx> /span>span classp>},/span>span classx> /span>span classp>},/span>span classx> /span>span classp>},/span>span classx> /span>span classp>},/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>UpdateTransactionDisplay/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>TransactionDisplayRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>TransactionDisplayRequest/span>span classp>{/span> span classn>Test/span> span classp>/span> span classk>true/span>span classp>,/span> span classn>TerminalName/span> span classp>/span> span classs>Test Terminal/span>span classp>,/span> span classn>Transaction/span> span classp>/span> span classk>new/span> span classn>TransactionDisplayTransaction/span> span classp>{/span> span classn>Subtotal/span> span classp>/span> span classs>60.00/span>span classp>,/span> span classn>Tax/span> span classp>/span> span classs>5.00/span>span classp>,/span> span classn>Total/span> span classp>/span> span classs>65.00/span>span classp>,/span> span classn>Items/span> span classp>/span> span classk>new/span> span classn>List/span>span classp>span classn>TransactionDisplayItem/span>span classp>>/span> span classp>{/span> span classk>new/span> span classn>TransactionDisplayItem/span> span classp>{/span> span classn>Description/span> span classp>/span> span classs>Leki Trekking Poles/span>span classp>,/span> span classn>Price/span> span classp>/span> span classs>35.00/span>span classp>,/span> span classn>Quantity/span> span classp>/span> span classm>2/span>span classp>,/span> span classn>Extended/span> span classp>/span> span classs>70.00/span>span classp>,/span> span classn>Discounts/span> span classp>/span> span classk>new/span> span classn>List/span>span classp>span classn>TransactionDisplayDiscount/span>span classp>>/span> span classp>{/span> span classk>new/span> span classn>TransactionDisplayDiscount/span> span classp>{/span> span classn>Description/span> span classp>/span> span classs>memberDiscount/span>span classp>,/span> span classn>Amount/span> span classp>/span> span classs>10.00/span>span classp>,/span> span classp>}/span> span classp>},/span> span classp>}/span> span classp>},/span> span classp>},/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>Acknowledgement/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>UpdateTransactionDisplayAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TransactionDisplayRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.Acknowledgement/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TransactionDisplayTransaction/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TransactionDisplayItem/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TransactionDisplayDiscount/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>UpdateTransactionDisplayExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>TransactionDisplayRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>TransactionDisplayRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTest/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setTerminalName/span>span classo>(/span>span classs>Test Terminal/span>span classo>);/span> span classn>TransactionDisplayTransaction/span> span classn>transaction/span> span classo>/span> span classk>new/span> span classn>TransactionDisplayTransaction/span>span classo>();/span> span classn>transaction/span>span classo>./span>span classna>setSubtotal/span>span classo>(/span>span classs>60.00/span>span classo>);/span> span classn>transaction/span>span classo>./span>span classna>setTax/span>span classo>(/span>span classs>5.00/span>span classo>);/span> span classn>transaction/span>span classo>./span>span classna>setTotal/span>span classo>(/span>span classs>65.00/span>span classo>);/span> span classn>Collection/span> span classn>items/span> span classo>/span> span classk>new/span> span classn>ArrayList/span>span classo>();/span> span classn>TransactionDisplayItem/span> span classn>items0/span> span classo>/span> span classk>new/span> span classn>TransactionDisplayItem/span>span classo>();/span> span classn>items0/span>span classo>./span>span classna>setDescription/span>span classo>(/span>span classs>Leki Trekking Poles/span>span classo>);/span> span classn>items0/span>span classo>./span>span classna>setPrice/span>span classo>(/span>span classs>35.00/span>span classo>);/span> span classn>items0/span>span classo>./span>span classna>setQuantity/span>span classo>(/span>span classmi>2/span>span classo>);/span> span classn>items0/span>span classo>./span>span classna>setExtended/span>span classo>(/span>span classs>70.00/span>span classo>);/span> span classn>Collection/span> span classn>discounts/span> span classo>/span> span classk>new/span> span classn>ArrayList/span>span classo>();/span> span classn>TransactionDisplayDiscount/span> span classn>discounts0/span> span classo>/span> span classk>new/span> span classn>TransactionDisplayDiscount/span>span classo>();/span> span classn>discounts0/span>span classo>./span>span classna>setDescription/span>span classo>(/span>span classs>memberDiscount/span>span classo>);/span> span classn>discounts0/span>span classo>./span>span classna>setAmount/span>span classo>(/span>span classs>10.00/span>span classo>);/span> span classn>discounts/span>span classo>./span>span classna>add/span>span classo>(/span>span classn>discounts0/span>span classo>);/span> span classn>items0/span>span classo>./span>span classna>setDiscounts/span>span classo>(/span>span classn>discounts/span>span classo>);/span> span classn>items/span>span classo>./span>span classna>add/span>span classo>(/span>span classn>items0/span>span classo>);/span> span classn>transaction/span>span classo>./span>span classna>setItems/span>span classo>(/span>span classn>items/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setTransaction/span>span classo>(/span>span classn>transaction/span>span classo>);/span> span classc1>// Send the request/span> span classn>Acknowledgement/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>updateTransactionDisplay/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>test/span> span classo>>/span> span classkc>true/span>span classp>,/span> span classs1>terminalName/span> span classo>>/span> span classs1>Test Terminal/span>span classp>,/span> span classs1>transaction/span> span classo>>/span> span classp>/span> span classs1>subtotal/span> span classo>>/span> span classs1>60.00/span>span classp>,/span> span classs1>tax/span> span classo>>/span> span classs1>5.00/span>span classp>,/span> span classs1>total/span> span classo>>/span> span classs1>65.00/span>span classp>,/span> span classs1>items/span> span classo>>/span> span classp>/span> span classp>/span> span classs1>description/span> span classo>>/span> span classs1>Leki Trekking Poles/span>span classp>,/span> span classs1>price/span> span classo>>/span> span classs1>35.00/span>span classp>,/span> span classs1>quantity/span> span classo>>/span> span classmi>2/span>span classp>,/span> span classs1>extended/span> span classo>>/span> span classs1>70.00/span>span classp>,/span> span classs1>discounts/span> span classo>>/span> span classp>/span> span classp>/span> span classs1>description/span> span classo>>/span> span classs1>memberDiscount/span>span classp>,/span> span classs1>amount/span> span classo>>/span> span classs1>10.00/span>span classp>,/span> span classp>,/span> span classp>,/span> span classp>,/span> span classp>,/span> span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>updateTransactionDisplay/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>test: /span>span classkp>true/span>span classp>,/span> span classss>terminalName: /span>span classs1>Test Terminal/span>span classp>,/span> span classss>transaction: /span>span classp>{/span> span classss>subtotal: /span>span classs1>60.00/span>span classp>,/span> span classss>tax: /span>span classs1>5.00/span>span classp>,/span> span classss>total: /span>span classs1>65.00/span>span classp>,/span> span classss>items: /span>span classp>/span> span classp>{/span> span classss>description: /span>span classs1>Leki Trekking Poles/span>span classp>,/span> span classss>price: /span>span classs1>35.00/span>span classp>,/span> span classss>quantity: /span>span classmi>2/span>span classp>,/span> span classss>extended: /span>span classs1>70.00/span>span classp>,/span> span classss>discounts: /span>span classp>/span> span classp>{/span> span classss>description: /span>span classs1>memberDiscount/span>span classp>,/span> span classss>amount: /span>span classs1>10.00/span> span classp>}/span> span classp>/span> span classp>}/span> span classp>/span> span classp>}/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>updateTransactionDisplay/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>test/span>span classp>:/span> span classbp>True/span>span classp>,/span> span classs>terminalName/span>span classp>:/span> span classs>Test Terminal/span>span classp>,/span> span classs>transaction/span>span classp>:/span> span classp>{/span> span classs>subtotal/span>span classp>:/span> span classs>60.00/span>span classp>,/span> span classs>tax/span>span classp>:/span> span classs>5.00/span>span classp>,/span> span classs>total/span>span classp>:/span> span classs>65.00/span>span classp>,/span> span classs>items/span>span classp>:/span> span classp>/span> span classp>{/span> span classs>description/span>span classp>:/span> span classs>Leki Trekking Poles/span>span classp>,/span> span classs>price/span>span classp>:/span> span classs>35.00/span>span classp>,/span> span classs>quantity/span>span classp>:/span> span classmi>2/span>span classp>,/span> span classs>extended/span>span classp>:/span> span classs>70.00/span>span classp>,/span> span classs>discounts/span>span classp>:/span> span classp>/span> span classp>{/span> span classs>description/span>span classp>:/span> span classs>memberDiscount/span>span classp>,/span> span classs>amount/span>span classp>:/span> span classs>10.00/span>span classp>,/span> span classp>},/span> span classp>,/span> span classp>},/span> span classp>,/span> span classp>},/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>update_transaction_display/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>updateTransactionDisplay/span>span classp>({/span> span classna>test/span>span classp>:/span> span classkc>true/span>span classp>,/span> span classna>terminalName/span>span classp>:/span> span classs1>Test Terminal/span>span classp>,/span> span classna>transaction/span>span classp>:/span> span classp>{/span> span classna>subtotal/span>span classp>:/span> span classs1>60.00/span>span classp>,/span> span classna>tax/span>span classp>:/span> span classs1>5.00/span>span classp>,/span> span classna>total/span>span classp>:/span> span classs1>65.00/span>span classp>,/span> span classna>items/span>span classp>:/span> span classp>/span> span classp>{/span> span classna>description/span>span classp>:/span> span classs1>Leki Trekking Poles/span>span classp>,/span> span classna>price/span>span classp>:/span> span classs1>35.00/span>span classp>,/span> span classna>quantity/span>span classp>:/span> span classmi>2/span>span classp>,/span> span classna>extended/span>span classp>:/span> span classs1>70.00/span>span classp>,/span> span classna>discounts/span>span classp>:/span> span classp>/span> span classp>{/span> span classna>description/span>span classp>:/span> span classs1>memberDiscount/span>span classp>,/span> span classna>amount/span>span classp>:/span> span classs1>10.00/span>span classp>,/span> span classp>},/span> span classp>,/span> span classp>},/span> span classp>,/span> span classp>},/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TransactionDisplayRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>test/span> span classo>/span> span classkc>true/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>terminalName/span> span classo>/span> span classs1>Test Terminal/span>span classp>;/span>span classkd>const/span> span classnx>transaction/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TransactionDisplayTransaction/span>span classp>();/span>span classnx>transaction/span>span classp>./span>span classnx>subtotal/span> span classo>/span> span classs1>60.00/span>span classp>;/span>span classnx>transaction/span>span classp>./span>span classnx>tax/span> span classo>/span> span classs1>5.00/span>span classp>;/span>span classnx>transaction/span>span classp>./span>span classnx>total/span> span classo>/span> span classs1>65.00/span>span classp>;/span>span classkd>const/span> span classnx>items/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TransactionDisplayItem/span>span classp>();/span>span classnx>items/span>span classp>./span>span classnx>description/span> span classo>/span> span classs1>Leki Trekking Poles/span>span classp>;/span>span classnx>items/span>span classp>./span>span classnx>price/span> span classo>/span> span classs1>35.00/span>span classp>;/span>span classnx>items/span>span classp>./span>span classnx>quantity/span> span classo>/span> span classmi>2/span>span classp>;/span>span classnx>items/span>span classp>./span>span classnx>extended/span> span classo>/span> span classs1>70.00/span>span classp>;/span>span classkd>const/span> span classnx>discounts/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TransactionDisplayDiscount/span>span classp>();/span>span classnx>discounts/span>span classp>./span>span classnx>description/span> span classo>/span> span classs1>memberDiscount/span>span classp>;/span>span classnx>discounts/span>span classp>./span>span classnx>amount/span> span classo>/span> span classs1>10.00/span>span classp>;/span>span classnx>items/span>span classp>./span>span classnx>discounts/span> span classo>/span> span classp>/span>span classnx>discounts/span>span classp>;/span>span classnx>transaction/span>span classp>./span>span classnx>items/span> span classo>/span> span classp>/span>span classnx>items/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>transaction/span> span classo>/span> span classnx>transaction/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>updateTransactionDisplay/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>Acknowledgement/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classnb>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>var/span> span classn>transaction/span>span classo>:/span> span classp>/span>span classnf>String/span>span classp>:/span>span classn>Any/span>span classp>/span> span classo>/span> span classp>/span>span classo>:/span>span classp>/span> span classn>transaction/span>span classp>/span>span classs>subtotal/span>span classp>/span> span classo>/span> span classs>60.00/span> span classn>transaction/span>span classp>/span>span classs>tax/span>span classp>/span> span classo>/span> span classs>5.00/span> span classn>transaction/span>span classp>/span>span classs>total/span>span classp>/span> span classo>/span> span classs>65.00/span> span classn>var/span> span classn>items/span> span classo>/span> span classp>/span>span classnf>Any/span>span classp>();/span> span classn>var/span> span classn>items1/span>span classo>:/span> span classp>/span>span classnf>String/span>span classp>:/span>span classn>Any/span>span classp>/span> span classo>/span> span classp>/span>span classo>:/span>span classp>/span> span classn>items1/span>span classp>/span>span classs>description/span>span classp>/span> span classo>/span> span classs>Leki Trekking Poles/span> span classn>items1/span>span classp>/span>span classs>price/span>span classp>/span> span classo>/span> span classs>35.00/span> span classn>items1/span>span classp>/span>span classs>quantity/span>span classp>/span> span classo>/span> span classmi>2/span> span classn>items1/span>span classp>/span>span classs>extended/span>span classp>/span> span classo>/span> span classs>70.00/span> span classn>var/span> span classn>discounts/span> span classo>/span> span classp>/span>span classnf>Any/span>span classp>();/span> span classn>var/span> span classn>discounts1/span>span classo>:/span> span classp>/span>span classnf>String/span>span classp>:/span>span classn>Any/span>span classp>/span> span classo>/span> span classp>/span>span classo>:/span>span classp>/span> span classn>discounts1/span>span classp>/span>span classs>description/span>span classp>/span> span classo>/span> span classs>memberDiscount/span> span classn>discounts1/span>span classp>/span>span classs>amount/span>span classp>/span> span classo>/span> span classs>10.00/span> span classn>discounts/span>span classp>./span>span classn>append/span>span classp>(/span>span classn>discounts1/span>span classp>)/span> span classn>items1/span>span classp>/span>span classs>discounts/span>span classp>/span> span classo>/span> span classn>discounts/span> span classn>items/span>span classp>./span>span classn>append/span>span classp>(/span>span classn>items1/span>span classp>)/span> span classn>transaction/span>span classp>/span>span classs>items/span>span classp>/span> span classo>/span> span classn>items/span> span classn>request/span>span classp>/span>span classs>transaction/span>span classp>/span> span classo>/span> span classn>transaction/span> span classp>/span>span classn>client/span> span classnf>updateTransactionDisplayWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classkc>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classk>var/span> span classnv>transaction/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>transaction/span>span classp>/span>span classs>subtotal/span>span classp>/span> span classo>/span> span classs>60.00/span> span classn>transaction/span>span classp>/span>span classs>tax/span>span classp>/span> span classo>/span> span classs>5.00/span> span classn>transaction/span>span classp>/span>span classs>total/span>span classp>/span> span classo>/span> span classs>65.00/span> span classk>var/span> span classnv>items/span> span classo>/span> span classp>/span>span classkt>Any/span>span classp>();/span> span classk>var/span> span classnv>items1/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>items1/span>span classp>/span>span classs>description/span>span classp>/span> span classo>/span> span classs>Leki Trekking Poles/span> span classn>items1/span>span classp>/span>span classs>price/span>span classp>/span> span classo>/span> span classs>35.00/span> span classn>items1/span>span classp>/span>span classs>quantity/span>span classp>/span> span classo>/span> span classmi>2/span> span classn>items1/span>span classp>/span>span classs>extended/span>span classp>/span> span classo>/span> span classs>70.00/span> span classk>var/span> span classnv>discounts/span> span classo>/span> span classp>/span>span classkt>Any/span>span classp>();/span> span classk>var/span> span classnv>discounts1/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>discounts1/span>span classp>/span>span classs>description/span>span classp>/span> span classo>/span> span classs>memberDiscount/span> span classn>discounts1/span>span classp>/span>span classs>amount/span>span classp>/span> span classo>/span> span classs>10.00/span> span classn>discounts/span>span classo>./span>span classnf>append/span>span classp>(/span>span classn>discounts1/span>span classp>)/span> span classn>items1/span>span classp>/span>span classs>discounts/span>span classp>/span> span classo>/span> span classn>discounts/span> span classn>items/span>span classo>./span>span classnf>append/span>span classp>(/span>span classn>items1/span>span classp>)/span> span classn>transaction/span>span classp>/span>span classs>items/span>span classp>/span> span classo>/span> span classn>items/span> span classn>request/span>span classp>/span>span classs>transaction/span>span classp>/span> span classo>/span> span classn>transaction/span> span classn>client/span>span classo>./span>span classnf>updateTransactionDisplay/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>update_transaction_display_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classk>mut/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>TransactionDisplayRequest/span>span classp>{/span> span classn>test/span>span classp>:/span> span classk>true/span>span classp>,/span> span classn>terminal_name/span>span classp>:/span> span classs>Test Terminal/span>span classnf>.to_string/span>span classp>(),/span> span classn>transaction/span>span classp>:/span> span classnf>Some/span>span classp>(/span>span classnn>blockchyp/span>span classp>::/span>span classn>TransactionDisplayTransaction/span>span classp>{/span> span classn>subtotal/span>span classp>:/span> span classs>60.00/span>span classnf>.to_string/span>span classp>(),/span> span classn>tax/span>span classp>:/span> span classs>5.00/span>span classnf>.to_string/span>span classp>(),/span> span classn>total/span>span classp>:/span> span classs>65.00/span>span classnf>.to_string/span>span classp>(),/span> span classn>items/span>span classp>:/span> span classnf>Some/span>span classp>(/span>span classnd>vec!/span>span classp>/span> span classnn>blockchyp/span>span classp>::/span>span classn>TransactionDisplayItem/span>span classp>{/span> span classn>description/span>span classp>:/span> span classs>Leki Trekking Poles/span>span classnf>.to_string/span>span classp>(),/span> span classn>price/span>span classp>:/span> span classs>35.00/span>span classnf>.to_string/span>span classp>(),/span> span classn>quantity/span>span classp>:/span> span classmf>2.0/span>span classp>,/span> span classn>extended/span>span classp>:/span> span classs>70.00/span>span classnf>.to_string/span>span classp>(),/span> span classn>discounts/span>span classp>:/span> span classnf>Some/span>span classp>(/span>span classnd>vec!/span>span classp>/span> span classnn>blockchyp/span>span classp>::/span>span classn>TransactionDisplayDiscount/span>span classp>{/span> span classn>description/span>span classp>:/span> span classs>memberDiscount/span>span classnf>.to_string/span>span classp>(),/span> span classn>amount/span>span classp>:/span> span classs>10.00/span>span classnf>.to_string/span>span classp>(),/span> .span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>},/span> span classp>),/span> .span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>},/span> span classp>),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>}),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.update_transaction_display/span>span classp>(/span>span classo>&/span>span classk>mut/span> span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>update_transaction_display_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>Similar to em>New Transaction Display/em>, this variant allows developers to updateline item level data currently being displayed on the terminal./p>p>This feature is designed for situations where you want to update the terminal display asitems are scanned. You'll only have to send information to theterminal that's changed, which usually means the new line item and updated totals./p>p>If the terminal is not in line item display mode and you invoke this endpoint,the first invocation will behave like a em>New Transaction Display/em> call./p>p>At a minimum, you should send total information as part of a display request,including code>total/code>, code>tax/code>, and code>subtotal/code>./p>p>You can also send line item level data and each line item can have a code>description/code>,code>qty/code>, code>price/code>, and code>extended/code> price./p>p>If you fail to send an extended price, BlockChyp will multiply the code>qty/code> by thecode>price/code>. However, we strongly recommend you precalculate all the fields yourselfto ensure consistency. For example, your treatment of floating-point multiplication and roundingmay differ slightly from BlockChyp's./p>p>strong>Discounts/strong>/p>p>You have the option to show discounts on the display as individual line itemswith negative values or you can associate discounts with a specific line item.You can apply any number of discounts to an individual line item with a descriptionand amount./p>aside classinfo>There are two methods of sending line item level data to a terminal for customer display. Thisversion updates any line item level data that may be on the terminal./aside>aside classsuccess>b>Level III Processing/b>p>If line item display is used, any subsequent payment transaction will submit themost recent line item information for Level III processing. This may reduceinterchange fees for some merchants./p>/aside>h2 iddisplay-message>Display Message/h2>blockquote>p>Display Message Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>message/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -messagespan classo>/span>span classs2>Thank you for your business./span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>message/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -messagespan classo>/span>span classs2>Thank you for your business./span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>messageExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>MessageRequest/span>span classp>{/span>span classx> /span>span classn>Test/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classn>TerminalName/span>span classo>:/span>span classx> /span>span classs>Test Terminal/span>span classp>,/span>span classx> /span>span classn>Message/span>span classo>:/span>span classx> /span>span classs>Thank you for your business./span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>Message/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>MessageRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>MessageRequest/span>span classp>{/span> span classn>Test/span> span classp>/span> span classk>true/span>span classp>,/span> span classn>TerminalName/span> span classp>/span> span classs>Test Terminal/span>span classp>,/span> span classn>Message/span> span classp>/span> span classs>Thank you for your business./span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>Acknowledgement/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>MessageAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.MessageRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.Acknowledgement/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>MessageExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>MessageRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>MessageRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTest/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setTerminalName/span>span classo>(/span>span classs>Test Terminal/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setMessage/span>span classo>(/span>span classs>Thank you for your business./span>span classo>);/span> span classc1>// Send the request/span> span classn>Acknowledgement/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>message/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>test/span> span classo>>/span> span classkc>true/span>span classp>,/span> span classs1>terminalName/span> span classo>>/span> span classs1>Test Terminal/span>span classp>,/span> span classs1>message/span> span classo>>/span> span classs1>Thank you for your business./span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>message/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>test: /span>span classkp>true/span>span classp>,/span> span classss>terminalName: /span>span classs1>Test Terminal/span>span classp>,/span> span classss>message: /span>span classs1>Thank you for your business./span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>message/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>test/span>span classp>:/span> span classbp>True/span>span classp>,/span> span classs>terminalName/span>span classp>:/span> span classs>Test Terminal/span>span classp>,/span> span classs>message/span>span classp>:/span> span classs>Thank you for your business./span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>message/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>message/span>span classp>({/span> span classna>test/span>span classp>:/span> span classkc>true/span>span classp>,/span> span classna>terminalName/span>span classp>:/span> span classs1>Test Terminal/span>span classp>,/span> span classna>message/span>span classp>:/span> span classs1>Thank you for your business./span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>MessageRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>test/span> span classo>/span> span classkc>true/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>terminalName/span> span classo>/span> span classs1>Test Terminal/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>message/span> span classo>/span> span classs1>Thank you for your business./span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>message/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>Acknowledgement/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classnb>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>request/span>span classp>/span>span classs>message/span>span classp>/span> span classo>/span> span classs>Thank you for your business./span> span classp>/span>span classn>client/span> span classnf>messageWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classkc>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>request/span>span classp>/span>span classs>message/span>span classp>/span> span classo>/span> span classs>Thank you for your business./span> span classn>client/span>span classo>./span>span classnf>message/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>message_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classk>mut/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>MessageRequest/span>span classp>{/span> span classn>test/span>span classp>:/span> span classk>true/span>span classp>,/span> span classn>terminal_name/span>span classp>:/span> span classs>Test Terminal/span>span classnf>.to_string/span>span classp>(),/span> span classn>message/span>span classp>:/span> span classs>Thank you for your business./span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.message/span>span classp>(/span>span classo>&/span>span classk>mut/span> span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>message_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API displays a message on the payment terminal./p>p>Just specify the target terminal and the message using the code>message/code> parameter./p>h2 idboolean-prompt>Boolean Prompt/h2>blockquote>p>Boolean Prompt Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>boolean-prompt/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -promptspan classo>/span>span classs2>Would you like to become a member?/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>boolean-prompt/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -promptspan classo>/span>span classs2>Would you like to become a member?/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>booleanPromptExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>BooleanPromptRequest/span>span classp>{/span>span classx> /span>span classn>Test/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classn>TerminalName/span>span classo>:/span>span classx> /span>span classs>Test Terminal/span>span classp>,/span>span classx> /span>span classn>Prompt/span>span classo>:/span>span classx> /span>span classs>Would you like to become a member?/span>span classp>,/span>span classx> /span>span classn>YesCaption/span>span classo>:/span>span classx> /span>span classs>Yes/span>span classp>,/span>span classx> /span>span classn>NoCaption/span>span classo>:/span>span classx> /span>span classs>No/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>BooleanPrompt/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>BooleanPromptRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>BooleanPromptRequest/span>span classp>{/span> span classn>Test/span> span classp>/span> span classk>true/span>span classp>,/span> span classn>TerminalName/span> span classp>/span> span classs>Test Terminal/span>span classp>,/span> span classn>Prompt/span> span classp>/span> span classs>Would you like to become a member?/span>span classp>,/span> span classn>YesCaption/span> span classp>/span> span classs>Yes/span>span classp>,/span> span classn>NoCaption/span> span classp>/span> span classs>No/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>BooleanPromptResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>BooleanPromptAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.BooleanPromptRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.BooleanPromptResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>BooleanPromptExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>BooleanPromptRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>BooleanPromptRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTest/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setTerminalName/span>span classo>(/span>span classs>Test Terminal/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setPrompt/span>span classo>(/span>span classs>Would you like to become a member?/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setYesCaption/span>span classo>(/span>span classs>Yes/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setNoCaption/span>span classo>(/span>span classs>No/span>span classo>);/span> span classc1>// Send the request/span> span classn>BooleanPromptResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>booleanPrompt/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>test/span> span classo>>/span> span classkc>true/span>span classp>,/span> span classs1>terminalName/span> span classo>>/span> span classs1>Test Terminal/span>span classp>,/span> span classs1>prompt/span> span classo>>/span> span classs1>Would you like to become a member?/span>span classp>,/span> span classs1>yesCaption/span> span classo>>/span> span classs1>Yes/span>span classp>,/span> span classs1>noCaption/span> span classo>>/span> span classs1>No/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>booleanPrompt/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>test: /span>span classkp>true/span>span classp>,/span> span classss>terminalName: /span>span classs1>Test Terminal/span>span classp>,/span> span classss>prompt: /span>span classs1>Would you like to become a member?/span>span classp>,/span> span classss>yesCaption: /span>span classs1>Yes/span>span classp>,/span> span classss>noCaption: /span>span classs1>No/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>booleanPrompt/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>test/span>span classp>:/span> span classbp>True/span>span classp>,/span> span classs>terminalName/span>span classp>:/span> span classs>Test Terminal/span>span classp>,/span> span classs>prompt/span>span classp>:/span> span classs>Would you like to become a member?/span>span classp>,/span> span classs>yesCaption/span>span classp>:/span> span classs>Yes/span>span classp>,/span> span classs>noCaption/span>span classp>:/span> span classs>No/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>boolean_prompt/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>booleanPrompt/span>span classp>({/span> span classna>test/span>span classp>:/span> span classkc>true/span>span classp>,/span> span classna>terminalName/span>span classp>:/span> span classs1>Test Terminal/span>span classp>,/span> span classna>prompt/span>span classp>:/span> span classs1>Would you like to become a member?/span>span classp>,/span> span classna>yesCaption/span>span classp>:/span> span classs1>Yes/span>span classp>,/span> span classna>noCaption/span>span classp>:/span> span classs1>No/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>BooleanPromptRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>test/span> span classo>/span> span classkc>true/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>terminalName/span> span classo>/span> span classs1>Test Terminal/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>prompt/span> span classo>/span> span classs1>Would you like to become a member?/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>yesCaption/span> span classo>/span> span classs1>Yes/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>noCaption/span> span classo>/span> span classs1>No/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>booleanPrompt/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>BooleanPromptResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classnb>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>request/span>span classp>/span>span classs>prompt/span>span classp>/span> span classo>/span> span classs>Would you like to become a member?/span> span classn>request/span>span classp>/span>span classs>yesCaption/span>span classp>/span> span classo>/span> span classs>Yes/span> span classn>request/span>span classp>/span>span classs>noCaption/span>span classp>/span> span classo>/span> span classs>No/span> span classp>/span>span classn>client/span> span classnf>booleanPromptWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@response/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@response/span>span classp>)/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classkc>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>request/span>span classp>/span>span classs>prompt/span>span classp>/span> span classo>/span> span classs>Would you like to become a member?/span> span classn>request/span>span classp>/span>span classs>yesCaption/span>span classp>/span> span classo>/span> span classs>Yes/span> span classn>request/span>span classp>/span>span classs>noCaption/span>span classp>/span> span classo>/span> span classs>No/span> span classn>client/span>span classo>./span>span classnf>booleanPrompt/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classkt>NSLog/span>span classp>(/span>span classs>response/span> span classo>+/span> span classs>: /span> span classo>+/span> span classp>(/span>span classn>response/span>span classp>/span>span classs>response/span>span classp>/span> span classk>as?/span> span classkt>String/span>span classp>)/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>boolean_prompt_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classk>mut/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>BooleanPromptRequest/span>span classp>{/span> span classn>test/span>span classp>:/span> span classk>true/span>span classp>,/span> span classn>terminal_name/span>span classp>:/span> span classs>Test Terminal/span>span classnf>.to_string/span>span classp>(),/span> span classn>prompt/span>span classp>:/span> span classs>Would you like to become a member?/span>span classnf>.to_string/span>span classp>(),/span> span classn>yes_caption/span>span classp>:/span> span classs>Yes/span>span classnf>.to_string/span>span classp>(),/span> span classn>no_caption/span>span classp>:/span> span classs>No/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.boolean_prompt/span>span classp>(/span>span classo>&/span>span classk>mut/span> span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>boolean_prompt_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>response/span>span classp>:/span>span classw> /span>span classkc>true/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API prompts the customer to answer a yes or no question./p>p>You can specify the question or prompt with the code>prompt/code> parameter andthe response is returned in the code>response/code> field./p>p>This can be used for a number of use cases including starting a loyalty enrollmentworkflow or customer facing suggestive selling prompts./p>p>strong>Custom Captions/strong>/p>p>You can optionally override the "YES" and "NO" button captions byusing the code>yesCaption/code> and code>noCaption/code> request parameters./p>h2 idtext-prompt>Text Prompt/h2>blockquote>p>Text Prompt Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>text-prompt/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -promptTypespan classo>/span>span classs2>phone/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>text-prompt/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -promptTypespan classo>/span>span classs2>phone/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>textPromptExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>TextPromptRequest/span>span classp>{/span>span classx> /span>span classn>Test/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classn>TerminalName/span>span classo>:/span>span classx> /span>span classs>Test Terminal/span>span classp>,/span>span classx> /span>span classc>// Type of prompt. Can be email, phone, customer-number, or rewards-number./span>span classx> /span>span classn>PromptType/span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>PromptTypeEmail/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>TextPrompt/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>TextPromptRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>TextPromptRequest/span>span classp>{/span> span classn>Test/span> span classp>/span> span classk>true/span>span classp>,/span> span classn>TerminalName/span> span classp>/span> span classs>Test Terminal/span>span classp>,/span> span classn>PromptType/span> span classp>/span> span classn>PromptType/span>span classp>./span>span classn>Email/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>TextPromptResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>TextPromptAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TextPromptRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TextPromptResponse/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.PromptType/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>TextPromptExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>TextPromptRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>TextPromptRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTest/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setTerminalName/span>span classo>(/span>span classs>Test Terminal/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setPromptType/span>span classo>(/span>span classn>PromptType/span>span classo>./span>span classna>EMAIL/span>span classo>);/span> span classc1>// Send the request/span> span classn>TextPromptResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>textPrompt/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>test/span> span classo>>/span> span classkc>true/span>span classp>,/span> span classs1>terminalName/span> span classo>>/span> span classs1>Test Terminal/span>span classp>,/span> span classc1>// Type of prompt. Can be email, phone, customer-number, or/span> span classc1>// rewards-number./span> span classs1>promptType/span> span classo>>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>PROMPT_TYPE_EMAIL/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>textPrompt/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>test: /span>span classkp>true/span>span classp>,/span> span classss>terminalName: /span>span classs1>Test Terminal/span>span classp>,/span> span classc1># Type of prompt. Can be email, phone, customer-number, or/span> span classc1># rewards-number./span> span classss>promptType: /span>span classno>PromptType/span>span classo>::/span>span classno>EMAIL/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>textPrompt/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>test/span>span classp>:/span> span classbp>True/span>span classp>,/span> span classs>terminalName/span>span classp>:/span> span classs>Test Terminal/span>span classp>,/span> span classc># Type of prompt. Can be email, phone, customer-number, or/span> span classc># rewards-number./span> span classs>promptType/span>span classp>:/span> span classn>blockchyp/span>span classo>./span>span classn>PromptType/span>span classo>./span>span classn>EMAIL/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>text_prompt/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>textPrompt/span>span classp>({/span> span classna>test/span>span classp>:/span> span classkc>true/span>span classp>,/span> span classna>terminalName/span>span classp>:/span> span classs1>Test Terminal/span>span classp>,/span> span classc1>// Type of prompt. Can be email, phone, customer-number, or/span> span classc1>// rewards-number./span> span classna>promptType/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>PromptType/span>span classp>./span>span classnx>EMAIL/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TextPromptRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>test/span> span classo>/span> span classkc>true/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>terminalName/span> span classo>/span> span classs1>Test Terminal/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>promptType/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>PromptType/span>span classp>./span>span classnx>EMAIL/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>textPrompt/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TextPromptResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classnb>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>request/span>span classp>/span>span classs>promptType/span>span classp>/span> span classo>/span> span classn>PROMPT_TYPE_EMAIL/span> span classp>/span>span classn>client/span> span classnf>textPromptWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@response/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@response/span>span classp>)/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classkc>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>request/span>span classp>/span>span classs>promptType/span>span classp>/span> span classo>/span> span classkt>PROMPT_TYPE_EMAIL/span> span classn>client/span>span classo>./span>span classnf>textPrompt/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classkt>NSLog/span>span classp>(/span>span classs>response/span> span classo>+/span> span classs>: /span> span classo>+/span> span classp>(/span>span classn>response/span>span classp>/span>span classs>response/span>span classp>/span> span classk>as?/span> span classkt>String/span>span classp>)/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>text_prompt_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classk>mut/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>TextPromptRequest/span>span classp>{/span> span classn>test/span>span classp>:/span> span classk>true/span>span classp>,/span> span classn>terminal_name/span>span classp>:/span> span classs>Test Terminal/span>span classnf>.to_string/span>span classp>(),/span> span classn>prompt_type/span>span classp>:/span> span classnn>blockchyp/span>span classp>::/span>span classnn>PromptType/span>span classp>::/span>span classn>Email/span>span classp>,/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.text_prompt/span>span classp>(/span>span classo>&/span>span classk>mut/span> span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>text_prompt_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>response/span>span classp>:/span>span classw> /span>span classs2>9136488888/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API prompts the customer to enter numeric or alphanumeric data./p>p>Due to PCI rules, free-form prompts are not permitted when the responsecould be any valid string. The reason for this is that a maliciousdeveloper (not you, of course) could use text prompts to ask the customer toinput a card number or PIN code./p>p>This means that instead of providing a prompt, you provide a code>promptType/code> instead./p>p>The prompt types currently supported are listed below:/p>ul>li>strong>phone/strong>: Captures a phone number./li>li>strong>email/strong>: Captures an email address./li>li>strong>first-name/strong>: Captures a first name./li>li>strong>last-name/strong>: Captures a last name./li>li>strong>customer-number/strong>: Captures a customer number./li>li>strong>rewards-number/strong>: Captures a rewards number./li>/ul>p>You can specify the prompt with the code>promptType/code> parameter andthe response is returned in the code>response/code> field./p>h2 idlist-terminals>List Terminals/h2>blockquote>p>List Terminals Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>list-terminals/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>list-terminals/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>terminalsExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>TerminalProfileRequest/span>span classp>{}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>Terminals/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>TerminalProfileRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>TerminalProfileRequest/span>span classp>{/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>TerminalProfileResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>TerminalsAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TerminalProfileRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TerminalProfileResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>TerminalsExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>TerminalProfileRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>TerminalProfileRequest/span>span classo>();/span> span classc1>// Send the request/span> span classn>TerminalProfileResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>terminals/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>terminals/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>terminals/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>terminals/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>terminals/span>span classp>({/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TerminalProfileRequest/span>span classp>();/span>span classnx>client/span>span classp>./span>span classnx>terminals/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TerminalProfileResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classp>/span>span classn>client/span> span classnf>terminalsWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>client/span>span classo>./span>span classnf>terminals/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>terminals_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>TerminalProfileRequest/span>span classp>{/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.terminals/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>terminals_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>results/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>HKLVQNWVNAI6ZDIYVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>ipAddress/span>span classp>:/span>span classw> /span>span classs2>192.168.55.115/span>span classp>,/span>span classw> /span>span classs2>terminalName/span>span classp>:/span>span classw> /span>span classs2>Test Terminal/span>span classp>,/span>span classw> /span>span classs2>terminalType/span>span classp>:/span>span classw> /span>span classs2>LUXE8000/span>span classp>,/span>span classw> /span>span classs2>terminalTypeDisplayString/span>span classp>:/span>span classw> /span>span classs2>Equinox Luxe 8500i/span>span classp>,/span>span classw> /span>span classs2>blockChypFirmwareVersion/span>span classp>:/span>span classw> /span>span classs2>1.18.1-466.20211119173638git7eef201/span>span classp>,/span>span classw> /span>span classs2>cloudBased/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>publicKey/span>span classp>:/span>span classw> /span>span classs2>11tchWXtVzRVa836UBgmRhLmVJETN4zc8A7TsuobPco88zm1gSf/span>span classp>,/span>span classw> /span>span classs2>serialNumber/span>span classp>:/span>span classw> /span>span classs2>A1724003000070/span>span classp>,/span>span classw> /span>span classs2>online/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>since/span>span classp>:/span>span classw> /span>span classs2>41m25s/span>span classp>,/span>span classw> /span>span classs2>totalMemory/span>span classp>:/span>span classw> /span>span classmi>225576/span>span classp>,/span>span classw> /span>span classs2>totalStorage/span>span classp>:/span>span classw> /span>span classmi>194830336/span>span classp>,/span>span classw> /span>span classs2>availableMemory/span>span classp>:/span>span classw> /span>span classmi>118440/span>span classp>,/span>span classw> /span>span classs2>availableStorage/span>span classp>:/span>span classw> /span>span classmi>104386560/span>span classp>,/span>span classw> /span>span classs2>usedMemory/span>span classp>:/span>span classw> /span>span classmi>107136/span>span classp>,/span>span classw> /span>span classs2>usedStorage/span>span classp>:/span>span classw> /span>span classmi>90443776/span>span classp>,/span>span classw> /span>span classs2>brandingPreview/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>groupId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>groupName/span>span classp>:/span>span classw> /span>span classs2>/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant & Partner/li>li>strong>Required Role:/strong> Terminal Management/li>/ul>p>This API returns details about terminals associated with a merchant account./p>p>Status and resource information is returned for all terminals along with a preview of the current branding image displayed on the terminal/p>h2 iddeactivate-terminal>Deactivate Terminal/h2>blockquote>p>Deactivate Terminal Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>deactivate-terminal/span> -terminalIdspan classo>/span>span classs2><TERMINAL ID>/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>deactivate-terminal/span> -terminalIdspan classo>/span>span classs2><TERMINAL ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>deactivateTerminalExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>TerminalDeactivationRequest/span>span classp>{/span>span classx> /span>span classn>TerminalID/span>span classo>:/span>span classx> /span>span classs><TERMINAL ID>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>DeactivateTerminal/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>TerminalDeactivationRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>TerminalDeactivationRequest/span>span classp>{/span> span classn>TerminalId/span> span classp>/span> span classs><TERMINAL ID>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>Acknowledgement/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>DeactivateTerminalAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TerminalDeactivationRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.Acknowledgement/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>DeactivateTerminalExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>TerminalDeactivationRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>TerminalDeactivationRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTerminalId/span>span classo>(/span>span classs><TERMINAL ID>/span>span classo>);/span> span classc1>// Send the request/span> span classn>Acknowledgement/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>deactivateTerminal/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>terminalId/span> span classo>>/span> span classs1><TERMINAL ID>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>deactivateTerminal/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>terminalId: /span>span classs1><TERMINAL ID>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>deactivateTerminal/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>terminalId/span>span classp>:/span> span classs><TERMINAL ID>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>deactivate_terminal/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>deactivateTerminal/span>span classp>({/span> span classna>terminalId/span>span classp>:/span> span classs1><TERMINAL ID>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TerminalDeactivationRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>terminalId/span> span classo>/span> span classs1><TERMINAL ID>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>deactivateTerminal/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>Acknowledgement/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>terminalId/span>span classp>/span> span classo>/span> span classs><TERMINAL ID>/span> span classp>/span>span classn>client/span> span classnf>deactivateTerminalWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>terminalId/span>span classp>/span> span classo>/span> span classs><TERMINAL ID>/span> span classn>client/span>span classo>./span>span classnf>deactivateTerminal/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>deactivate_terminal_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>TerminalDeactivationRequest/span>span classp>{/span> span classn>terminal_id/span>span classp>:/span> span classs><TERMINAL ID>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.deactivate_terminal/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>deactivate_terminal_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant & Partner/li>li>strong>Required Role:/strong> Terminal Management/li>/ul>p>This API deactivates a payment terminal./p>p>If the terminal exists and is currently online, it will be removed from the merchant's terminal inventory. The terminal will be remotely cleared and factory reset./p>h2 idactivate-terminal>Activate Terminal/h2>blockquote>p>Activate Terminal Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>activate-terminal/span> -terminalNamespan classo>/span>span classs2>Test Terminal/span> -codespan classo>/span>span classs2><ACTIVATION CODE>/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>activate-terminal/span> -terminalNamespan classo>/span>span classs2>Test Terminal/span> -codespan classo>/span>span classs2><ACTIVATION CODE>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>activateTerminalExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>TerminalActivationRequest/span>span classp>{/span>span classx> /span>span classn>TerminalName/span>span classo>:/span>span classx> /span>span classs>Test Terminal/span>span classp>,/span>span classx> /span>span classn>ActivationCode/span>span classo>:/span>span classx> /span>span classs><ACTIVATION CODE>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>ActivateTerminal/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>TerminalActivationRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>TerminalActivationRequest/span>span classp>{/span> span classn>TerminalName/span> span classp>/span> span classs>Test Terminal/span>span classp>,/span> span classn>ActivationCode/span> span classp>/span> span classs><ACTIVATION CODE>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>Acknowledgement/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>ActivateTerminalAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TerminalActivationRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.Acknowledgement/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>ActivateTerminalExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>TerminalActivationRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>TerminalActivationRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTerminalName/span>span classo>(/span>span classs>Test Terminal/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setActivationCode/span>span classo>(/span>span classs><ACTIVATION CODE>/span>span classo>);/span> span classc1>// Send the request/span> span classn>Acknowledgement/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>activateTerminal/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>terminalName/span> span classo>>/span> span classs1>Test Terminal/span>span classp>,/span> span classs1>activationCode/span> span classo>>/span> span classs1><ACTIVATION CODE>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>activateTerminal/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>terminalName: /span>span classs1>Test Terminal/span>span classp>,/span> span classss>activationCode: /span>span classs1><ACTIVATION CODE>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>activateTerminal/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>terminalName/span>span classp>:/span> span classs>Test Terminal/span>span classp>,/span> span classs>activationCode/span>span classp>:/span> span classs><ACTIVATION CODE>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>activate_terminal/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>activateTerminal/span>span classp>({/span> span classna>terminalName/span>span classp>:/span> span classs1>Test Terminal/span>span classp>,/span> span classna>activationCode/span>span classp>:/span> span classs1><ACTIVATION CODE>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TerminalActivationRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>terminalName/span> span classo>/span> span classs1>Test Terminal/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>activationCode/span> span classo>/span> span classs1><ACTIVATION CODE>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>activateTerminal/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>Acknowledgement/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>request/span>span classp>/span>span classs>activationCode/span>span classp>/span> span classo>/span> span classs><ACTIVATION CODE>/span> span classp>/span>span classn>client/span> span classnf>activateTerminalWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>request/span>span classp>/span>span classs>activationCode/span>span classp>/span> span classo>/span> span classs><ACTIVATION CODE>/span> span classn>client/span>span classo>./span>span classnf>activateTerminal/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>activate_terminal_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>TerminalActivationRequest/span>span classp>{/span> span classn>terminal_name/span>span classp>:/span> span classs>Test Terminal/span>span classnf>.to_string/span>span classp>(),/span> span classn>activation_code/span>span classp>:/span> span classs><ACTIVATION CODE>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.activate_terminal/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>activate_terminal_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant & Partner/li>li>strong>Required Role:/strong> Terminal Management/li>/ul>p>This API activates a payment terminal./p>p>If successful, the payment terminal will restart, generate new encryption keys, and download any activebranding assets for the merchant account it's been added to./p>p>Activation requests require an activation code and a unique terminal name. All terminal names must be unique acrossa merchant account./p>p>Optional Parameters/p>ul>li>strong>merchantId:/strong> For partner scoped API credentials, a merchant ID is required. For merchant scoped API credentials, the merchant ID is implicit and cannot be overridden./li>li>strong>cloudRelay:/strong> Activates the terminal in cloud relay mode./li>/ul>aside classwarning>Note that terminals are activated in local mode by default, meaning that SDK requests will assume the terminal is accessible on the same LAN as the client application. If the application that willbe communicating with the terminal is cloud based or on a different network segment, the `cloudRelay`parameter is required and must be set to true in order for the terminal to be accessible./aside>h2 idreboot-terminal>Reboot Terminal/h2>blockquote>p>Reboot Terminal Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>reboot/span> -terminalspan classo>/span>span classs2>Test Terminal/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>reboot/span> -terminalspan classo>/span>span classs2>Test Terminal/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>rebootExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>PingRequest/span>span classp>{/span>span classx> /span>span classn>TerminalName/span>span classo>:/span>span classx> /span>span classs>Test Terminal/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>Reboot/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>PingRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>PingRequest/span>span classp>{/span> span classn>TerminalName/span> span classp>/span> span classs>Test Terminal/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>Acknowledgement/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>RebootAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.PingRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.Acknowledgement/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>RebootExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>PingRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>PingRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTerminalName/span>span classo>(/span>span classs>Test Terminal/span>span classo>);/span> span classc1>// Send the request/span> span classn>Acknowledgement/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>reboot/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>terminalName/span> span classo>>/span> span classs1>Test Terminal/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>reboot/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>terminalName: /span>span classs1>Test Terminal/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>reboot/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>terminalName/span>span classp>:/span> span classs>Test Terminal/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>reboot/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>reboot/span>span classp>({/span> span classna>terminalName/span>span classp>:/span> span classs1>Test Terminal/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>PingRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>terminalName/span> span classo>/span> span classs1>Test Terminal/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>reboot/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>Acknowledgement/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classp>/span>span classn>client/span> span classnf>rebootWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>client/span>span classo>./span>span classnf>reboot/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>reboot_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classk>mut/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>PingRequest/span>span classp>{/span> span classn>terminal_name/span>span classp>:/span> span classs>Test Terminal/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.reboot/span>span classp>(/span>span classo>&/span>span classk>mut/span> span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>reboot_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API reboots the terminal./p>h1 idterms-amp-conditions-api>Terms & Conditions API/h1>p>Developers can use BlockChyp to display and capture acceptance of contracts or agreements related to transactions.These agreements can be any long-form contract ranging from rental agreements to HIPPA disclosures./p>p>There are two basic approaches to terms and conditions capture. Merchants can store contract templates in BlockChyp or they can send the full agreement text as part of every API call. The right approach will largely depend on whether or not the system being integrated with BlockChyp already has a mechanism for organizing and managing agreements. For systems that already have this feature built in, it's probably not necessary to use Terms and Conditions./p>p>When agreements are displayed on a terminal, the consumer can scroll through and read the entire agreement,and provide a signature. Results are returned as part of the API response, but BlockChyp also stores a record of the agreement including the signature image, timestamp, and the full text of the agreement that was agreed to./p>p>The Terms and Conditions Log APIs can be used to search and retrieve acceptance records. Those recordscan also be linked to a transaction if a transaction id is provided with the original API request./p>h2 idterms-amp-conditions-capture>Terms & Conditions Capture/h2>blockquote>p>Terms & Conditions Capture Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>tc/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -tcNamespan classo>/span>span classs2>HIPPA Disclosure/span> -tcContentspan classo>/span>span classs2>Loreum Ipsum.../span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>tc/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -tcNamespan classo>/span>span classs2>HIPPA Disclosure/span> -tcContentspan classo>/span>span classs2>Loreum Ipsum.../span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>termsAndConditionsExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>TermsAndConditionsRequest/span>span classp>{/span>span classx> /span>span classn>Test/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classn>TerminalName/span>span classo>:/span>span classx> /span>span classs>Test Terminal/span>span classp>,/span>span classx> /span>span classc>// Alias for a Terms and Conditions template configured in the BlockChyp dashboard./span>span classx> /span>span classn>TCAlias/span>span classo>:/span>span classx> /span>span classs>hippa/span>span classp>,/span>span classx> /span>span classc>// Name of the contract or document if not using an alias./span>span classx> /span>span classn>TCName/span>span classo>:/span>span classx> /span>span classs>HIPPA Disclosure/span>span classp>,/span>span classx> /span>span classc>// Full text of the contract or disclosure if not using an alias./span>span classx> /span>span classn>TCContent/span>span classo>:/span>span classx> /span>span classs>Full contract text/span>span classp>,/span>span classx> /span>span classc>// file format for the signature image./span>span classx> /span>span classn>SigFormat/span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>SignatureFormatPNG/span>span classp>,/span>span classx> /span>span classc>// width of the signature image in pixels./span>span classx> /span>span classn>SigWidth/span>span classo>:/span>span classx> /span>span classm>200/span>span classp>,/span>span classx> /span>span classc>// Whether or not a signature is required. Defaults to true./span>span classx> /span>span classn>SigRequired/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>TermsAndConditions/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>TermsAndConditionsRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>TermsAndConditionsRequest/span>span classp>{/span> span classn>Test/span> span classp>/span> span classk>true/span>span classp>,/span> span classn>TerminalName/span> span classp>/span> span classs>Test Terminal/span>span classp>,/span> span classn>TcAlias/span> span classp>/span> span classs>hippa/span>span classp>,/span> span classn>TcName/span> span classp>/span> span classs>HIPPA Disclosure/span>span classp>,/span> span classn>TcContent/span> span classp>/span> span classs>Full contract text/span>span classp>,/span> span classn>SigFormat/span> span classp>/span> span classn>SignatureFormat/span>span classp>./span>span classn>PNG/span>span classp>,/span> span classn>SigWidth/span> span classp>/span> span classm>200/span>span classp>,/span> span classn>SigRequired/span> span classp>/span> span classk>true/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>TermsAndConditionsResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>TermsAndConditionsAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TermsAndConditionsRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TermsAndConditionsResponse/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.SignatureFormat/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>TermsAndConditionsExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>TermsAndConditionsRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>TermsAndConditionsRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTest/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setTerminalName/span>span classo>(/span>span classs>Test Terminal/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setTcAlias/span>span classo>(/span>span classs>hippa/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setTcName/span>span classo>(/span>span classs>HIPPA Disclosure/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setTcContent/span>span classo>(/span>span classs>Full contract text/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setSigFormat/span>span classo>(/span>span classn>SignatureFormat/span>span classo>./span>span classna>PNG/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setSigWidth/span>span classo>(/span>span classmi>200/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setSigRequired/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classc1>// Send the request/span> span classn>TermsAndConditionsResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>termsAndConditions/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>test/span> span classo>>/span> span classkc>true/span>span classp>,/span> span classs1>terminalName/span> span classo>>/span> span classs1>Test Terminal/span>span classp>,/span> span classc1>// Alias for a Terms and Conditions template configured in the BlockChyp/span> span classc1>// dashboard./span> span classs1>tcAlias/span> span classo>>/span> span classs1>hippa/span>span classp>,/span> span classc1>// Name of the contract or document if not using an alias./span> span classs1>tcName/span> span classo>>/span> span classs1>HIPPA Disclosure/span>span classp>,/span> span classc1>// Full text of the contract or disclosure if not using an alias./span> span classs1>tcContent/span> span classo>>/span> span classs1>Full contract text/span>span classp>,/span> span classc1>// File format for the signature image./span> span classs1>sigFormat/span> span classo>>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>SIGNATURE_FORMAT_PNG/span>span classp>,/span> span classc1>// Width of the signature image in pixels./span> span classs1>sigWidth/span> span classo>>/span> span classmi>200/span>span classp>,/span> span classc1>// Whether or not a signature is required. Defaults to true./span> span classs1>sigRequired/span> span classo>>/span> span classkc>true/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>termsAndConditions/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>test: /span>span classkp>true/span>span classp>,/span> span classss>terminalName: /span>span classs1>Test Terminal/span>span classp>,/span> span classc1># Alias for a Terms and Conditions template configured in the BlockChyp/span> span classc1># dashboard./span> span classss>tcAlias: /span>span classs1>hippa/span>span classp>,/span> span classc1># Name of the contract or document if not using an alias./span> span classss>tcName: /span>span classs1>HIPPA Disclosure/span>span classp>,/span> span classc1># Full text of the contract or disclosure if not using an alias./span> span classss>tcContent: /span>span classs1>Full contract text/span>span classp>,/span> span classc1># File format for the signature image./span> span classss>sigFormat: /span>span classno>SignatureFormat/span>span classo>::/span>span classno>PNG/span>span classp>,/span> span classc1># Width of the signature image in pixels./span> span classss>sigWidth: /span>span classmi>200/span>span classp>,/span> span classc1># Whether or not a signature is required. Defaults to true./span> span classss>sigRequired: /span>span classkp>true/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>termsAndConditions/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>test/span>span classp>:/span> span classbp>True/span>span classp>,/span> span classs>terminalName/span>span classp>:/span> span classs>Test Terminal/span>span classp>,/span> span classc># Alias for a Terms and Conditions template configured in the BlockChyp/span> span classc># dashboard./span> span classs>tcAlias/span>span classp>:/span> span classs>hippa/span>span classp>,/span> span classc># Name of the contract or document if not using an alias./span> span classs>tcName/span>span classp>:/span> span classs>HIPPA Disclosure/span>span classp>,/span> span classc># Full text of the contract or disclosure if not using an alias./span> span classs>tcContent/span>span classp>:/span> span classs>Full contract text/span>span classp>,/span> span classc># File format for the signature image./span> span classs>sigFormat/span>span classp>:/span> span classn>blockchyp/span>span classo>./span>span classn>SignatureFormat/span>span classo>./span>span classn>PNG/span>span classp>,/span> span classc># Width of the signature image in pixels./span> span classs>sigWidth/span>span classp>:/span> span classmi>200/span>span classp>,/span> span classc># Whether or not a signature is required. Defaults to true./span> span classs>sigRequired/span>span classp>:/span> span classbp>True/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>terms_and_conditions/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>termsAndConditions/span>span classp>({/span> span classna>test/span>span classp>:/span> span classkc>true/span>span classp>,/span> span classna>terminalName/span>span classp>:/span> span classs1>Test Terminal/span>span classp>,/span> span classc1>// Alias for a Terms and Conditions template configured in the BlockChyp/span> span classc1>// dashboard./span> span classna>tcAlias/span>span classp>:/span> span classs1>hippa/span>span classp>,/span> span classc1>// Name of the contract or document if not using an alias./span> span classna>tcName/span>span classp>:/span> span classs1>HIPPA Disclosure/span>span classp>,/span> span classc1>// Full text of the contract or disclosure if not using an alias./span> span classna>tcContent/span>span classp>:/span> span classs1>Full contract text/span>span classp>,/span> span classc1>// File format for the signature image./span> span classna>sigFormat/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>SignatureFormat/span>span classp>./span>span classnx>PNG/span>span classp>,/span> span classc1>// Width of the signature image in pixels./span> span classna>sigWidth/span>span classp>:/span> span classmi>200/span>span classp>,/span> span classc1>// Whether or not a signature is required. Defaults to true./span> span classna>sigRequired/span>span classp>:/span> span classkc>true/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TermsAndConditionsRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>test/span> span classo>/span> span classkc>true/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>terminalName/span> span classo>/span> span classs1>Test Terminal/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>tcAlias/span> span classo>/span> span classs1>hippa/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>tcName/span> span classo>/span> span classs1>HIPPA Disclosure/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>tcContent/span> span classo>/span> span classs1>Full contract text/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>sigFormat/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>SignatureFormat/span>span classp>./span>span classnx>PNG/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>sigWidth/span> span classo>/span> span classmi>200/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>sigRequired/span> span classo>/span> span classkc>true/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>termsAndConditions/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TermsAndConditionsResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classnb>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>request/span>span classp>/span>span classs>tcAlias/span>span classp>/span> span classo>/span> span classs>hippa/span> span classn>request/span>span classp>/span>span classs>tcName/span>span classp>/span> span classo>/span> span classs>HIPPA Disclosure/span> span classn>request/span>span classp>/span>span classs>tcContent/span>span classp>/span> span classo>/span> span classs>Full contract text/span> span classn>request/span>span classp>/span>span classs>sigFormat/span>span classp>/span> span classo>/span> span classn>SIGNATURE_FORMAT_PNG/span> span classn>request/span>span classp>/span>span classs>sigWidth/span>span classp>/span> span classo>/span> span classmi>200/span> span classn>request/span>span classp>/span>span classs>sigRequired/span>span classp>/span> span classo>/span> span classnb>true/span> span classp>/span>span classn>client/span> span classnf>termsAndConditionsWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@sig/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@sig/span>span classp>)/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@sigFile/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@sigFile/span>span classp>)/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classkc>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>request/span>span classp>/span>span classs>tcAlias/span>span classp>/span> span classo>/span> span classs>hippa/span> span classn>request/span>span classp>/span>span classs>tcName/span>span classp>/span> span classo>/span> span classs>HIPPA Disclosure/span> span classn>request/span>span classp>/span>span classs>tcContent/span>span classp>/span> span classo>/span> span classs>Full contract text/span> span classn>request/span>span classp>/span>span classs>sigFormat/span>span classp>/span> span classo>/span> span classkt>SIGNATURE_FORMAT_PNG/span> span classn>request/span>span classp>/span>span classs>sigWidth/span>span classp>/span> span classo>/span> span classmi>200/span> span classn>request/span>span classp>/span>span classs>sigRequired/span>span classp>/span> span classo>/span> span classkc>true/span> span classn>client/span>span classo>./span>span classnf>termsAndConditions/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classkt>NSLog/span>span classp>(/span>span classs>sig/span> span classo>+/span> span classs>: /span> span classo>+/span> span classp>(/span>span classn>response/span>span classp>/span>span classs>sig/span>span classp>/span> span classk>as?/span> span classkt>String/span>span classp>)/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classkt>NSLog/span>span classp>(/span>span classs>sigFile/span> span classo>+/span> span classs>: /span> span classo>+/span> span classp>(/span>span classn>response/span>span classp>/span>span classs>sigFile/span>span classp>/span> span classk>as?/span> span classkt>String/span>span classp>)/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>terms_and_conditions_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classk>mut/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>TermsAndConditionsRequest/span>span classp>{/span> span classn>test/span>span classp>:/span> span classk>true/span>span classp>,/span> span classn>terminal_name/span>span classp>:/span> span classs>Test Terminal/span>span classnf>.to_string/span>span classp>(),/span> span classn>tc_alias/span>span classp>:/span> span classs>hippa/span>span classnf>.to_string/span>span classp>(),/span> span classn>tc_name/span>span classp>:/span> span classs>HIPPA Disclosure/span>span classnf>.to_string/span>span classp>(),/span> span classn>tc_content/span>span classp>:/span> span classs>Full contract text/span>span classnf>.to_string/span>span classp>(),/span> span classn>sig_format/span>span classp>:/span> span classnn>blockchyp/span>span classp>::/span>span classnn>SignatureFormat/span>span classp>::/span>span classn>PNG/span>span classp>,/span> span classn>sig_width/span>span classp>:/span> span classmi>200/span>span classp>,/span> span classn>sig_required/span>span classp>:/span> span classk>true/span>span classp>,/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.terms_and_conditions/span>span classp>(/span>span classo>&/span>span classk>mut/span> span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>terms_and_conditions_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Terms & Conditions Management/li>/ul>p>This API allows you to prompt a customer to accept a legal agreement on the terminaland (usually) capture their signature./p>p>Content for the agreement can be specified in two ways. You can reference apreviously configured T&C template or pass in the full agreement text with every request./p>p>strong>Using Templates/strong>/p>p>If your application doesn't keep track of agreements you can leverage BlockChyp'stemplate system. You can create any number of T&C Templates in the merchant dashboardand pass in the code>tcAlias/code> flag to specify which one should display./p>p>strong>Raw Content/strong>/p>p>If your system keeps track of the agreement language or executes complicated mergingand rendering logic, you can bypass our template system and pass in the full text withevery transaction. Use code>tcName/code> to pass in the agreement name and code>tcContent/code> topass in the contract text. Note that only plain text is supported./p>p>strong>Bypassing Signatures/strong>/p>p>Signature images are captured by default. If for some reason this doesn't fit youruse case and you'd like to capture acceptance without actually capturing a signature image, setthe code>disableSignature/code> flag in the request./p>p>strong>Terms & Conditions Log/strong>/p>p>Every time a user accepts an agreement on the terminal, the signature image (if captured),will be uploaded to the gateway. The image will also be added to the log along with the full text of theagreement. This preserves the historical record in the event that standard agreementsor templates change over time./p>p>strong>Associating Agreements with Transactions/strong>/p>p>To associate a Terms & Conditions log entry with a transaction, just pass in theTransaction ID or Transaction Ref for the associated transaction./p>aside classwarning>By default signature images are not returned with Terms and Conditions requests.BlockChyp archives the signature image in the Terms and Conditions log whereit can be recalled at any time. If you want to get the signature image in theresponse, add `sigFormat` and `sigWidth` or `sigFile` properties to the request./aside>h2 idlist-templates>List Templates/h2>blockquote>p>List Templates Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>tc-templates/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>tc-templates/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>tcTemplatesExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>TermsAndConditionsTemplateRequest/span>span classp>{}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>TCTemplates/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>TermsAndConditionsTemplateRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>TermsAndConditionsTemplateRequest/span>span classp>{/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>TermsAndConditionsTemplateResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>TcTemplatesAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TermsAndConditionsTemplateRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TermsAndConditionsTemplateResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>TcTemplatesExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>TermsAndConditionsTemplateRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>TermsAndConditionsTemplateRequest/span>span classo>();/span> span classc1>// Send the request/span> span classn>TermsAndConditionsTemplateResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>tcTemplates/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>tcTemplates/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>tcTemplates/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>tc_templates/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>tcTemplates/span>span classp>({/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TermsAndConditionsTemplateRequest/span>span classp>();/span>span classnx>client/span>span classp>./span>span classnx>tcTemplates/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TermsAndConditionsTemplateResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classp>/span>span classn>client/span> span classnf>tcTemplatesWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>client/span>span classo>./span>span classnf>tcTemplates/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>tc_templates_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>TermsAndConditionsTemplateRequest/span>span classp>{/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.tc_templates/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>tc_templates_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>results/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>TVZ5W6G23MI6ZCIUVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>alias/span>span classp>:/span>span classw> /span>span classs2>HIPPA/span>span classp>,/span>span classw> /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>HIPPA Disclosure/span>span classp>,/span>span classw> /span>span classs2>content/span>span classp>:/span>span classw> /span>span classs2>Lorem ipsum dolor sit amet./span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Terms & Conditions Management/li>/ul>p>This API returns all terms and conditions templates associated with a merchant account./p>h2 idget-template>Get Template/h2>blockquote>p>Get Template Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>tc-templates/span> -templateIdspan classo>/span>span classs2><TEMPLATE ID>/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>tc-templates/span> -templateIdspan classo>/span>span classs2><TEMPLATE ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>tcTemplateExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>TermsAndConditionsTemplateRequest/span>span classp>{/span>span classx> /span>span classn>TemplateID/span>span classo>:/span>span classx> /span>span classs><TEMPLATE ID>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>TCTemplate/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>TermsAndConditionsTemplateRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>TermsAndConditionsTemplateRequest/span>span classp>{/span> span classn>TemplateId/span> span classp>/span> span classs><TEMPLATE ID>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>TermsAndConditionsTemplate/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>TcTemplateAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TermsAndConditionsTemplateRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TermsAndConditionsTemplate/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>TcTemplateExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>TermsAndConditionsTemplateRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>TermsAndConditionsTemplateRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTemplateId/span>span classo>(/span>span classs><TEMPLATE ID>/span>span classo>);/span> span classc1>// Send the request/span> span classn>TermsAndConditionsTemplate/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>tcTemplate/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>templateId/span> span classo>>/span> span classs1><TEMPLATE ID>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>tcTemplate/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>templateId: /span>span classs1><TEMPLATE ID>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>tcTemplate/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>templateId/span>span classp>:/span> span classs><TEMPLATE ID>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>tc_template/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>tcTemplate/span>span classp>({/span> span classna>templateId/span>span classp>:/span> span classs1><TEMPLATE ID>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TermsAndConditionsTemplateRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>templateId/span> span classo>/span> span classs1><TEMPLATE ID>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>tcTemplate/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TermsAndConditionsTemplate/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>templateId/span>span classp>/span> span classo>/span> span classs><TEMPLATE ID>/span> span classp>/span>span classn>client/span> span classnf>tcTemplateWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>templateId/span>span classp>/span> span classo>/span> span classs><TEMPLATE ID>/span> span classn>client/span>span classo>./span>span classnf>tcTemplate/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>tc_template_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>TermsAndConditionsTemplateRequest/span>span classp>{/span> span classn>template_id/span>span classp>:/span> span classs><TEMPLATE ID>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.tc_template/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>tc_template_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>JPREGGW24II6ZLRZVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>alias/span>span classp>:/span>span classw> /span>span classs2>HIPPA/span>span classp>,/span>span classw> /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>HIPPA Disclosure/span>span classp>,/span>span classw> /span>span classs2>content/span>span classp>:/span>span classw> /span>span classs2>Lorem ipsum dolor sit amet./span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Terms & Conditions Management/li>/ul>p>This API returns as single terms and conditions template./p>h2 idupdate-template>Update Template/h2>blockquote>p>Update Template Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>update-tc-template/span> -tcAliasspan classo>/span>span classs2>HIPPA/span> -tcNamespan classo>/span>span classs2>HIPPA Disclosure/span> -tcContentspan classo>/span>span classs2>Lorem Ipsum/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>update-tc-template/span> -tcAliasspan classo>/span>span classs2>HIPPA/span> -tcNamespan classo>/span>span classs2>HIPPA Disclosure/span> -tcContentspan classo>/span>span classs2>Lorem Ipsum/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>tcUpdateTemplateExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>TermsAndConditionsTemplate/span>span classp>{/span>span classx> /span>span classn>Alias/span>span classo>:/span>span classx> /span>span classs>HIPPA/span>span classp>,/span>span classx> /span>span classn>Name/span>span classo>:/span>span classx> /span>span classs>HIPPA Disclosure/span>span classp>,/span>span classx> /span>span classn>Content/span>span classo>:/span>span classx> /span>span classs>Lorem ipsum dolor sit amet./span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>TCUpdateTemplate/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>TermsAndConditionsTemplate/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>TermsAndConditionsTemplate/span>span classp>{/span> span classn>Alias/span> span classp>/span> span classs>HIPPA/span>span classp>,/span> span classn>Name/span> span classp>/span> span classs>HIPPA Disclosure/span>span classp>,/span> span classn>Content/span> span classp>/span> span classs>Lorem ipsum dolor sit amet./span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>TermsAndConditionsTemplate/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>TcUpdateTemplateAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TermsAndConditionsTemplate/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TermsAndConditionsTemplate/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>TcUpdateTemplateExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>TermsAndConditionsTemplate/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>TermsAndConditionsTemplate/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setAlias/span>span classo>(/span>span classs>HIPPA/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setName/span>span classo>(/span>span classs>HIPPA Disclosure/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setContent/span>span classo>(/span>span classs>Lorem ipsum dolor sit amet./span>span classo>);/span> span classc1>// Send the request/span> span classn>TermsAndConditionsTemplate/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>tcUpdateTemplate/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>alias/span> span classo>>/span> span classs1>HIPPA/span>span classp>,/span> span classs1>name/span> span classo>>/span> span classs1>HIPPA Disclosure/span>span classp>,/span> span classs1>content/span> span classo>>/span> span classs1>Lorem ipsum dolor sit amet./span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>tcUpdateTemplate/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>alias: /span>span classs1>HIPPA/span>span classp>,/span> span classss>name: /span>span classs1>HIPPA Disclosure/span>span classp>,/span> span classss>content: /span>span classs1>Lorem ipsum dolor sit amet./span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>tcUpdateTemplate/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>alias/span>span classp>:/span> span classs>HIPPA/span>span classp>,/span> span classs>name/span>span classp>:/span> span classs>HIPPA Disclosure/span>span classp>,/span> span classs>content/span>span classp>:/span> span classs>Lorem ipsum dolor sit amet./span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>tc_update_template/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>tcUpdateTemplate/span>span classp>({/span> span classna>alias/span>span classp>:/span> span classs1>HIPPA/span>span classp>,/span> span classna>name/span>span classp>:/span> span classs1>HIPPA Disclosure/span>span classp>,/span> span classna>content/span>span classp>:/span> span classs1>Lorem ipsum dolor sit amet./span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TermsAndConditionsTemplate/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>alias/span> span classo>/span> span classs1>HIPPA/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>name/span> span classo>/span> span classs1>HIPPA Disclosure/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>content/span> span classo>/span> span classs1>Lorem ipsum dolor sit amet./span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>tcUpdateTemplate/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TermsAndConditionsTemplate/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>alias/span>span classp>/span> span classo>/span> span classs>HIPPA/span> span classn>request/span>span classp>/span>span classs>name/span>span classp>/span> span classo>/span> span classs>HIPPA Disclosure/span> span classn>request/span>span classp>/span>span classs>content/span>span classp>/span> span classo>/span> span classs>Lorem ipsum dolor sit amet./span> span classp>/span>span classn>client/span> span classnf>tcUpdateTemplateWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>alias/span>span classp>/span> span classo>/span> span classs>HIPPA/span> span classn>request/span>span classp>/span>span classs>name/span>span classp>/span> span classo>/span> span classs>HIPPA Disclosure/span> span classn>request/span>span classp>/span>span classs>content/span>span classp>/span> span classo>/span> span classs>Lorem ipsum dolor sit amet./span> span classn>client/span>span classo>./span>span classnf>tcUpdateTemplate/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>tc_update_template_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>TermsAndConditionsTemplate/span>span classp>{/span> span classn>alias/span>span classp>:/span> span classs>HIPPA/span>span classnf>.to_string/span>span classp>(),/span> span classn>name/span>span classp>:/span> span classs>HIPPA Disclosure/span>span classnf>.to_string/span>span classp>(),/span> span classn>content/span>span classp>:/span> span classs>Lorem ipsum dolor sit amet./span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.tc_update_template/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>tc_update_template_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>TVZ5W6G23MI6ZCIUVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>alias/span>span classp>:/span>span classw> /span>span classs2>HIPPA/span>span classp>,/span>span classw> /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>HIPPA Disclosure/span>span classp>,/span>span classw> /span>span classs2>content/span>span classp>:/span>span classw> /span>span classs2>Lorem ipsum dolor sit amet./span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Terms & Conditions Management/li>/ul>p>This API updates or creates a terms and conditions template./p>p>Terms and conditions templates are fairly simple and essentially consist of a name, content, and alias./p>p>The name is the caption that will be displayed at the top of the screen. The alias is a code or shortdescription that will be used in subsequence API calls to refer to the template./p>p>Content is the full text of the contract or agreement. Currently, no special formatting ormerge behavior is supported. Only plain text is supported./p>h2 iddelete-template>Delete Template/h2>blockquote>p>Delete Template Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>delete-tc-template/span> -templateIdspan classo>/span>span classs2><TEMPLATE ID>/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>delete-tc-template/span> -templateIdspan classo>/span>span classs2><TEMPLATE ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>tcDeleteTemplateExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>TermsAndConditionsTemplateRequest/span>span classp>{/span>span classx> /span>span classn>TemplateID/span>span classo>:/span>span classx> /span>span classs><TEMPLATE ID>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>TCDeleteTemplate/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>TermsAndConditionsTemplateRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>TermsAndConditionsTemplateRequest/span>span classp>{/span> span classn>TemplateId/span> span classp>/span> span classs><TEMPLATE ID>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>Acknowledgement/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>TcDeleteTemplateAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TermsAndConditionsTemplateRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.Acknowledgement/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>TcDeleteTemplateExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>TermsAndConditionsTemplateRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>TermsAndConditionsTemplateRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTemplateId/span>span classo>(/span>span classs><TEMPLATE ID>/span>span classo>);/span> span classc1>// Send the request/span> span classn>Acknowledgement/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>tcDeleteTemplate/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>templateId/span> span classo>>/span> span classs1><TEMPLATE ID>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>tcDeleteTemplate/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>templateId: /span>span classs1><TEMPLATE ID>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>tcDeleteTemplate/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>templateId/span>span classp>:/span> span classs><TEMPLATE ID>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>tc_delete_template/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>tcDeleteTemplate/span>span classp>({/span> span classna>templateId/span>span classp>:/span> span classs1><TEMPLATE ID>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TermsAndConditionsTemplateRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>templateId/span> span classo>/span> span classs1><TEMPLATE ID>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>tcDeleteTemplate/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>Acknowledgement/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>templateId/span>span classp>/span> span classo>/span> span classs><TEMPLATE ID>/span> span classp>/span>span classn>client/span> span classnf>tcDeleteTemplateWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>templateId/span>span classp>/span> span classo>/span> span classs><TEMPLATE ID>/span> span classn>client/span>span classo>./span>span classnf>tcDeleteTemplate/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>tc_delete_template_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>TermsAndConditionsTemplateRequest/span>span classp>{/span> span classn>template_id/span>span classp>:/span> span classs><TEMPLATE ID>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.tc_delete_template/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>tc_delete_template_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Terms & Conditions Management/li>/ul>p>This API deletes a terms and conditions template./p>p>If a template is deleted, its alias can be reused and any previous Terms & Conditions log entryderived from the template being deleted is fully preserved since log entries always includea complete independent copy of the agreement text./p>h2 idterms-amp-conditions-log>Terms & Conditions Log/h2>blockquote>p>Terms & Conditions Log Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>tc-log/span> -logEntryIdspan classo>/span>span classs2><LOG ENTRY ID>/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>tc-log/span> -logEntryIdspan classo>/span>span classs2><LOG ENTRY ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>tcLogExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>TermsAndConditionsLogRequest/span>span classp>{/span>span classx> /span>span classn>LogEntryID/span>span classo>:/span>span classx> /span>span classs><LOG ENTRY ID>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>TCLog/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>TermsAndConditionsLogRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>TermsAndConditionsLogRequest/span>span classp>{/span> span classn>LogEntryId/span> span classp>/span> span classs><LOG ENTRY ID>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>TermsAndConditionsLogResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>TcLogAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TermsAndConditionsLogRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TermsAndConditionsLogResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>TcLogExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>TermsAndConditionsLogRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>TermsAndConditionsLogRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setLogEntryId/span>span classo>(/span>span classs><LOG ENTRY ID>/span>span classo>);/span> span classc1>// Send the request/span> span classn>TermsAndConditionsLogResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>tcLog/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>logEntryId/span> span classo>>/span> span classs1><LOG ENTRY ID>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>tcLog/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>logEntryId: /span>span classs1><LOG ENTRY ID>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>tcLog/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>logEntryId/span>span classp>:/span> span classs><LOG ENTRY ID>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>tc_log/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>tcLog/span>span classp>({/span> span classna>logEntryId/span>span classp>:/span> span classs1><LOG ENTRY ID>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TermsAndConditionsLogRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>logEntryId/span> span classo>/span> span classs1><LOG ENTRY ID>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>tcLog/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TermsAndConditionsLogResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>logEntryId/span>span classp>/span> span classo>/span> span classs><LOG ENTRY ID>/span> span classp>/span>span classn>client/span> span classnf>tcLogWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>logEntryId/span>span classp>/span> span classo>/span> span classs><LOG ENTRY ID>/span> span classn>client/span>span classo>./span>span classnf>tcLog/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>tc_log_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>TermsAndConditionsLogRequest/span>span classp>{/span> span classn>log_entry_id/span>span classp>:/span> span classs><LOG ENTRY ID>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.tc_log/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>tc_log_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>maxResults/span>span classp>:/span>span classw> /span>span classmi>250/span>span classp>,/span>span classw> /span>span classs2>startIndex/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>resultCount/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>results/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>DMFNCJG3NMI6ZEUAVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>terminalId/span>span classp>:/span>span classw> /span>span classs2>5WXL5MW23AI6ZJYWVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>terminalName/span>span classp>:/span>span classw> /span>span classs2>Test Terminal/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classs2>05/24/2022 10:09:54 AM/span>span classp>,/span>span classw> /span>span classs2>transactionRef/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>alias/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>HIPPA Disclosure/span>span classp>,/span>span classw> /span>span classs2>content/span>span classp>:/span>span classw> /span>span classs2>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum ullamcorper id urna quis pulvinar. Pellentesque vestibulum justo ac nulla consectetur tristique. Suspendisse arcu arcu, viverra vel luctus non, dapibus vitae augue. Aenean ac volutpat purus. Curabitur in lacus nisi. Nam vel sagittis eros. Curabitur faucibus ut nisl in pulvinar. Nunc egestas, orci ut porttitor tempus, ante mauris pellentesque ex, nec feugiat purus arcu ac metus. Cras sodales ornare lobortis. Aenean lacinia ultricies purus quis pharetra. Cras vestibulum nulla et magna eleifend eleifend. Nunc nibh dolor, malesuada ut suscipit vitae, bibendum quis dolor. Phasellus ultricies ex vitae dolor malesuada, vel dignissim neque accumsan./span>span classp>,/span>span classw> /span>span classs2>contentLeader/span>span classp>:/span>span classw> /span>span classs2>Lorem ipsum dolor sit amet, cons.../span>span classp>,/span>span classw> /span>span classs2>hasSignature/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>signature/span>span classp>:/span>span classw> /span>span classs2>/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Terms & Conditions Management/li>/ul>p>This API allows developers to search and sort through terms and conditions log entries./p>p>The default API call with no parameters will return the last 250 log entries in descending order./p>p>Optional parameters can be used to filter and query the data set./p>ul>li>strong>transactionId:/strong> If provided, returns only those log entries associated with a specific transactions. Paging and date filters are ignored if this parameter is used./li>li>strong>maxResults:/strong> The max number of results to return in a single page. Defaults to 250 and 250 is the maximum value./li>li>strong>startIndex/strong> The zero based start index of results within the full result set to return. Used to advance pages. For example, if the page size is 10 and you wish to return the second page of results, send a startIndex of 10. /li>li>strong>startDate/strong>: An optional start date for results provided as an ISO 8601 timestamp. (e.g. 2022-05-24T13:51:38+00:00)/li>li>strong>endDate/strong>: An optional end date for results provided as an ISO 8601 timestamp. (e.g. 2022-05-24T13:51:38+00:00)/li>/ul>h2 idterms-amp-conditions-details>Terms & Conditions Details/h2>blockquote>p>Terms & Conditions Details Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>tc-entry/span> -logEntryIdspan classo>/span>span classs2><ENTRY ID>/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>tc-entry/span> -logEntryIdspan classo>/span>span classs2><ENTRY ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>tcEntryExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>TermsAndConditionsLogRequest/span>span classp>{/span>span classx> /span>span classn>LogEntryID/span>span classo>:/span>span classx> /span>span classs><ENTRY ID>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>TCEntry/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>TermsAndConditionsLogRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>TermsAndConditionsLogRequest/span>span classp>{/span> span classn>LogEntryId/span> span classp>/span> span classs><ENTRY ID>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>TermsAndConditionsLogEntry/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>TcEntryAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TermsAndConditionsLogRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TermsAndConditionsLogEntry/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>TcEntryExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>TermsAndConditionsLogRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>TermsAndConditionsLogRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setLogEntryId/span>span classo>(/span>span classs><ENTRY ID>/span>span classo>);/span> span classc1>// Send the request/span> span classn>TermsAndConditionsLogEntry/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>tcEntry/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>logEntryId/span> span classo>>/span> span classs1><ENTRY ID>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>tcEntry/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>logEntryId: /span>span classs1><ENTRY ID>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>tcEntry/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>logEntryId/span>span classp>:/span> span classs><ENTRY ID>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>tc_entry/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>tcEntry/span>span classp>({/span> span classna>logEntryId/span>span classp>:/span> span classs1><ENTRY ID>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TermsAndConditionsLogRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>logEntryId/span> span classo>/span> span classs1><ENTRY ID>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>tcEntry/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TermsAndConditionsLogEntry/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>logEntryId/span>span classp>/span> span classo>/span> span classs><ENTRY ID>/span> span classp>/span>span classn>client/span> span classnf>tcEntryWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>logEntryId/span>span classp>/span> span classo>/span> span classs><ENTRY ID>/span> span classn>client/span>span classo>./span>span classnf>tcEntry/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>tc_entry_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>TermsAndConditionsLogRequest/span>span classp>{/span> span classn>log_entry_id/span>span classp>:/span> span classs><ENTRY ID>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.tc_entry/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>tc_entry_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>PXQOBEG3NMI6ZKGUVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>terminalId/span>span classp>:/span>span classw> /span>span classs2>5WXL5MW23AI6ZJYWVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>terminalName/span>span classp>:/span>span classw> /span>span classs2>Test Terminal/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classs2>05/24/2022 10:12:26 AM/span>span classp>,/span>span classw> /span>span classs2>transactionRef/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>alias/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>HIPPA Disclosure/span>span classp>,/span>span classw> /span>span classs2>content/span>span classp>:/span>span classw> /span>span classs2>Lorem ipsum dolor sit amet, consectetur adipiscing elit./span>span classp>,/span>span classw> /span>span classs2>contentLeader/span>span classp>:/span>span classw> /span>span classs2>Lorem ipsum dolor sit amet, cons.../span>span classp>,/span>span classw> /span>span classs2>hasSignature/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>sigFormat/span>span classp>:/span>span classw> /span>span classs2>PNG/span>span classp>,/span>span classw> /span>span classs2>signature/span>span classp>:/span>span classw> /span>span classs2>iVBORw0KGgoAAAANSUhEUgAAAyAAAADcCAIAAAAHqlLAAAAdJklEQVR4nOz.../span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Terms & Conditions Management/li>/ul>p>This API returns details for a single terms and conditions log entry. The code>logEntryId/code> of the record to be returned is the only required parameter./p>p>The signature image is returned as Base 64 encoded binary in the image format specified by the code>sigFormat/code> field. The default format is PNG./p>h1 idtoken-api>Token API/h1>p>BlockChyp supports saved payments and recurring payments through the use of tokens. Tokens can be createdvia the Enroll API or the web tokenizer. Once created, these tokens can be used for subsequent payments or associated with customer records as saved payment methods./p>p>Tokens are limited to a single merchant by default, but can be shared across an organization for multi-location merchants by special arrangement with BlockChyp. Contact your BlockChyp rep to setup token sharing./p>h2 idenroll>Enroll/h2>blockquote>p>Enroll Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>enroll/span> -terminalspan classo>/span>span classs2>Test Terminal/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>enroll/span> -terminalspan classo>/span>span classs2>Test Terminal/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>enrollExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>EnrollRequest/span>span classp>{/span>span classx> /span>span classn>Test/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classn>TerminalName/span>span classo>:/span>span classx> /span>span classs>Test Terminal/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>Enroll/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Approved/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>approved/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>EnrollRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>EnrollRequest/span>span classp>{/span> span classn>Test/span> span classp>/span> span classk>true/span>span classp>,/span> span classn>TerminalName/span> span classp>/span> span classs>Test Terminal/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>EnrollResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>EnrollAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.EnrollRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.EnrollResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>EnrollExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>EnrollRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>EnrollRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTest/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setTerminalName/span>span classo>(/span>span classs>Test Terminal/span>span classo>);/span> span classc1>// Send the request/span> span classn>EnrollResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>enroll/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>test/span> span classo>>/span> span classkc>true/span>span classp>,/span> span classs1>terminalName/span> span classo>>/span> span classs1>Test Terminal/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>enroll/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>test: /span>span classkp>true/span>span classp>,/span> span classss>terminalName: /span>span classs1>Test Terminal/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>enroll/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>test/span>span classp>:/span> span classbp>True/span>span classp>,/span> span classs>terminalName/span>span classp>:/span> span classs>Test Terminal/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>enroll/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>enroll/span>span classp>({/span> span classna>test/span>span classp>:/span> span classkc>true/span>span classp>,/span> span classna>terminalName/span>span classp>:/span> span classs1>Test Terminal/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>EnrollRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>test/span> span classo>/span> span classkc>true/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>terminalName/span> span classo>/span> span classs1>Test Terminal/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>enroll/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>EnrollResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classnb>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classp>/span>span classn>client/span> span classnf>enrollWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@approved/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@approved/span>span classp>);/span> span classp>}/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@token/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@token/span>span classp>)/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classkc>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>client/span>span classo>./span>span classnf>enroll/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>approved/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>approved/span>span classp>)/span> span classp>}/span> span classkt>NSLog/span>span classp>(/span>span classs>token/span> span classo>+/span> span classs>: /span> span classo>+/span> span classp>(/span>span classn>response/span>span classp>/span>span classs>token/span>span classp>/span> span classk>as?/span> span classkt>String/span>span classp>)/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>enroll_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classk>mut/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>EnrollRequest/span>span classp>{/span> span classn>test/span>span classp>:/span> span classk>true/span>span classp>,/span> span classn>terminal_name/span>span classp>:/span> span classs>Test Terminal/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.enroll/span>span classp>(/span>span classo>&/span>span classk>mut/span> span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.approved/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>approved/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>enroll_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>approved/span>span classp>,/span>span classw> /span>span classs2>approved/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>authCode/span>span classp>:/span>span classw> /span>span classs2>727291/span>span classp>,/span>span classw> /span>span classs2>transactionId/span>span classp>:/span>span classw> /span>span classs2>KJ3DPKELBAI6VOTWNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>transactionRef/span>span classp>:/span>span classw> /span>span classs2>64614152008/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>enroll/span>span classp>,/span>span classw> /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classs2>2020-04-30T20:49:26Z/span>span classp>,/span>span classw> /span>span classs2>tickBlock/span>span classp>:/span>span classw> /span>span classs2>009991a8ac7b6a4420760e1e14e1689c88be2a610a033d6908c1b04b5c00f9da/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>token/span>span classp>:/span>span classw> /span>span classs2>EKROTO2K5BCQJT4I555LQJLMWA/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>CHIP/span>span classp>,/span>span classw> /span>span classs2>paymentType/span>span classp>:/span>span classw> /span>span classs2>VISA/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************0010/span>span classp>,/span>span classw> /span>span classs2>cardHolder/span>span classp>:/span>span classw> /span>span classs2>UAT USA/Test Card 04/span>span classp>,/span>span classw> /span>span classs2>avsResponse/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>receiptSuggestions/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>aid/span>span classp>:/span>span classw> /span>span classs2>A0000000031010/span>span classp>,/span>span classw> /span>span classs2>arqc/span>span classp>:/span>span classw> /span>span classs2>3404F82DA10F3FF5/span>span classp>,/span>span classw> /span>span classs2>iad/span>span classp>:/span>span classw> /span>span classs2>06010A03A0B800/span>span classp>,/span>span classw> /span>span classs2>tvr/span>span classp>:/span>span classw> /span>span classs2>8000008800/span>span classp>,/span>span classw> /span>span classs2>tsi/span>span classp>:/span>span classw> /span>span classs2>6800/span>span classp>,/span>span classw> /span>span classs2>merchantName/span>span classp>:/span>span classw> /span>span classs2>Test Merchant/span>span classp>,/span>span classw> /span>span classs2>applicationLabel/span>span classp>:/span>span classw> /span>span classs2>VISA CREDIT/span>span classp>,/span>span classw> /span>span classs2>requestSignature/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************0010/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>enroll/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>CHIP/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>customer/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API allows you to tokenize and enroll a payment method in the tokenvault. You can also pass in customer information and associate thepayment method with a customer record./p>p>A token is returned in the response that can be used in subsequent charge,preauth, and refund transactions./p>p>strong>Gift Cards and EBT/strong>/p>p>Gift Cards and EBT cards cannot be tokenized./p>p>strong>E-Commerce Tokens/strong>/p>p>The tokens returned by the enroll API and the e-commerce web tokenizerare the same tokens and can be used interchangeably./p>aside classwarning>b>Token Expiration/b>p>Tokens and saved payment methods are valid for one year from the time they were last used. If a token is not used for over a year, it may be deleted./p>/aside>h2 idtoken-metadata>Token Metadata/h2>blockquote>p>Token Metadata Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>token-metadata/span> -tokenspan classo>/span>span classs2><TOKEN>/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>token-metadata/span> -tokenspan classo>/span>span classs2><TOKEN>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>tokenMetadataExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>TokenMetadataRequest/span>span classp>{/span>span classx> /span>span classn>Token/span>span classo>:/span>span classx> /span>span classs><TOKEN>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>TokenMetadata/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>TokenMetadataRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>TokenMetadataRequest/span>span classp>{/span> span classn>Token/span> span classp>/span> span classs><TOKEN>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>TokenMetadataResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>TokenMetadataAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TokenMetadataRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.TokenMetadataResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>TokenMetadataExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>TokenMetadataRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>TokenMetadataRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setToken/span>span classo>(/span>span classs><TOKEN>/span>span classo>);/span> span classc1>// Send the request/span> span classn>TokenMetadataResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>tokenMetadata/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>token/span> span classo>>/span> span classs1><TOKEN>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>tokenMetadata/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>token: /span>span classs1><TOKEN>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>tokenMetadata/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>token/span>span classp>:/span> span classs><TOKEN>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>token_metadata/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>tokenMetadata/span>span classp>({/span> span classna>token/span>span classp>:/span> span classs1><TOKEN>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TokenMetadataRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>token/span> span classo>/span> span classs1><TOKEN>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>tokenMetadata/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>TokenMetadataResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>token/span>span classp>/span> span classo>/span> span classs><TOKEN>/span> span classp>/span>span classn>client/span> span classnf>tokenMetadataWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>token/span>span classp>/span> span classo>/span> span classs><TOKEN>/span> span classn>client/span>span classo>./span>span classnf>tokenMetadata/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>token_metadata_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>TokenMetadataRequest/span>span classp>{/span> span classn>token/span>span classp>:/span> span classs><TOKEN>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.token_metadata/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>token_metadata_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>token/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>token/span>span classp>:/span>span classw> /span>span classs2>N2DTGDSSZNBAX7GT5HBZPHIOWA/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************4111/span>span classp>,/span>span classw> /span>span classs2>expiryMonth/span>span classp>:/span>span classw> /span>span classs2>12/span>span classp>,/span>span classw> /span>span classs2>expiryYear/span>span classp>:/span>span classw> /span>span classs2>12/span>span classp>,/span>span classw> /span>span classs2>paymentType/span>span classp>:/span>span classw> /span>span classs2>MC/span>span classp>,/span>span classw> /span>span classs2>customers/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>XK4LRURF6II6ZB7UVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>customerRef/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>firstName/span>span classp>:/span>span classw> /span>span classs2>Peter/span>span classp>,/span>span classw> /span>span classs2>lastName/span>span classp>:/span>span classw> /span>span classs2>Gregory/span>span classp>,/span>span classw> /span>span classs2>companyName/span>span classp>:/span>span classw> /span>span classs2>Raviga Capital/span>span classp>,/span>span classw> /span>span classs2>emailAddress/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>smsNumber/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>paymentMethods/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>XK4LRXBF6II6ZB7WVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>customerRef/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>firstName/span>span classp>:/span>span classw> /span>span classs2>Laurie/span>span classp>,/span>span classw> /span>span classs2>lastName/span>span classp>:/span>span classw> /span>span classs2>Bream/span>span classp>,/span>span classw> /span>span classs2>companyName/span>span classp>:/span>span classw> /span>span classs2>Bream Hall/span>span classp>,/span>span classw> /span>span classs2>emailAddress/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>smsNumber/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>paymentMethods/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API retrieves status and metadata information about a token, including any links to customer records. /p>p>This will also return any customer records related to the cardbehind the token. If the underlying card has been tokenizedmultiple times, all customers related to the card will be returned,even if those customer associations are related to other tokens./p>h2 idlink-token>Link Token/h2>blockquote>p>Link Token Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>link-token/span> -tokenspan classo>/span>span classs2><TOKEN>/span> -customerIdspan classo>/span>span classs2><CUSTOMER ID>/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>link-token/span> -tokenspan classo>/span>span classs2><TOKEN>/span> -customerIdspan classo>/span>span classs2><CUSTOMER ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>linkTokenExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>LinkTokenRequest/span>span classp>{/span>span classx> /span>span classn>Token/span>span classo>:/span>span classx> /span>span classs><TOKEN>/span>span classp>,/span>span classx> /span>span classn>CustomerID/span>span classo>:/span>span classx> /span>span classs><CUSTOMER ID>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>LinkToken/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>LinkTokenRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>LinkTokenRequest/span>span classp>{/span> span classn>Token/span> span classp>/span> span classs><TOKEN>/span>span classp>,/span> span classn>CustomerId/span> span classp>/span> span classs><CUSTOMER ID>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>Acknowledgement/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>LinkTokenAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.LinkTokenRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.Acknowledgement/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>LinkTokenExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>LinkTokenRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>LinkTokenRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setToken/span>span classo>(/span>span classs><TOKEN>/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setCustomerId/span>span classo>(/span>span classs><CUSTOMER ID>/span>span classo>);/span> span classc1>// Send the request/span> span classn>Acknowledgement/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>linkToken/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>token/span> span classo>>/span> span classs1><TOKEN>/span>span classp>,/span> span classs1>customerId/span> span classo>>/span> span classs1><CUSTOMER ID>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>linkToken/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>token: /span>span classs1><TOKEN>/span>span classp>,/span> span classss>customerId: /span>span classs1><CUSTOMER ID>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>linkToken/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>token/span>span classp>:/span> span classs><TOKEN>/span>span classp>,/span> span classs>customerId/span>span classp>:/span> span classs><CUSTOMER ID>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>link_token/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>linkToken/span>span classp>({/span> span classna>token/span>span classp>:/span> span classs1><TOKEN>/span>span classp>,/span> span classna>customerId/span>span classp>:/span> span classs1><CUSTOMER ID>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>LinkTokenRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>token/span> span classo>/span> span classs1><TOKEN>/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>customerId/span> span classo>/span> span classs1><CUSTOMER ID>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>linkToken/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>Acknowledgement/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>token/span>span classp>/span> span classo>/span> span classs><TOKEN>/span> span classn>request/span>span classp>/span>span classs>customerId/span>span classp>/span> span classo>/span> span classs><CUSTOMER ID>/span> span classp>/span>span classn>client/span> span classnf>linkTokenWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>token/span>span classp>/span> span classo>/span> span classs><TOKEN>/span> span classn>request/span>span classp>/span>span classs>customerId/span>span classp>/span> span classo>/span> span classs><CUSTOMER ID>/span> span classn>client/span>span classo>./span>span classnf>linkToken/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>link_token_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>LinkTokenRequest/span>span classp>{/span> span classn>token/span>span classp>:/span> span classs><TOKEN>/span>span classnf>.to_string/span>span classp>(),/span> span classn>customer_id/span>span classp>:/span> span classs><CUSTOMER ID>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.link_token/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>link_token_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API links a payment token with a customer record. Usually this would only be neededto reverse a previous unlink operation./p>h2 idunlink-token>Unlink Token/h2>blockquote>p>Unlink Token Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>unlink-token/span> -tokenspan classo>/span>span classs2><TOKEN>/span> -customerIdspan classo>/span>span classs2><CUSTOMER ID>/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>unlink-token/span> -tokenspan classo>/span>span classs2><TOKEN>/span> -customerIdspan classo>/span>span classs2><CUSTOMER ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>unlinkTokenExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>UnlinkTokenRequest/span>span classp>{/span>span classx> /span>span classn>Token/span>span classo>:/span>span classx> /span>span classs><TOKEN>/span>span classp>,/span>span classx> /span>span classn>CustomerID/span>span classo>:/span>span classx> /span>span classs><CUSTOMER ID>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>UnlinkToken/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>UnlinkTokenRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>UnlinkTokenRequest/span>span classp>{/span> span classn>Token/span> span classp>/span> span classs><TOKEN>/span>span classp>,/span> span classn>CustomerId/span> span classp>/span> span classs><CUSTOMER ID>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>Acknowledgement/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>UnlinkTokenAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.UnlinkTokenRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.Acknowledgement/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>UnlinkTokenExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>UnlinkTokenRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>UnlinkTokenRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setToken/span>span classo>(/span>span classs><TOKEN>/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setCustomerId/span>span classo>(/span>span classs><CUSTOMER ID>/span>span classo>);/span> span classc1>// Send the request/span> span classn>Acknowledgement/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>unlinkToken/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>token/span> span classo>>/span> span classs1><TOKEN>/span>span classp>,/span> span classs1>customerId/span> span classo>>/span> span classs1><CUSTOMER ID>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>unlinkToken/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>token: /span>span classs1><TOKEN>/span>span classp>,/span> span classss>customerId: /span>span classs1><CUSTOMER ID>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>unlinkToken/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>token/span>span classp>:/span> span classs><TOKEN>/span>span classp>,/span> span classs>customerId/span>span classp>:/span> span classs><CUSTOMER ID>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>unlink_token/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>unlinkToken/span>span classp>({/span> span classna>token/span>span classp>:/span> span classs1><TOKEN>/span>span classp>,/span> span classna>customerId/span>span classp>:/span> span classs1><CUSTOMER ID>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>UnlinkTokenRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>token/span> span classo>/span> span classs1><TOKEN>/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>customerId/span> span classo>/span> span classs1><CUSTOMER ID>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>unlinkToken/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>Acknowledgement/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>token/span>span classp>/span> span classo>/span> span classs><TOKEN>/span> span classn>request/span>span classp>/span>span classs>customerId/span>span classp>/span> span classo>/span> span classs><CUSTOMER ID>/span> span classp>/span>span classn>client/span> span classnf>unlinkTokenWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>token/span>span classp>/span> span classo>/span> span classs><TOKEN>/span> span classn>request/span>span classp>/span>span classs>customerId/span>span classp>/span> span classo>/span> span classs><CUSTOMER ID>/span> span classn>client/span>span classo>./span>span classnf>unlinkToken/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>unlink_token_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>UnlinkTokenRequest/span>span classp>{/span> span classn>token/span>span classp>:/span> span classs><TOKEN>/span>span classnf>.to_string/span>span classp>(),/span> span classn>customer_id/span>span classp>:/span> span classs><CUSTOMER ID>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.unlink_token/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>unlink_token_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API removes a payment token link from a customer record./p>p>This will remove links between the customer record and all tokensfor the same underlying card./p>h2 idupdate-token>Update Token/h2>blockquote>p>Update Token Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>update-token/span> -tokenspan classo>/span>span classs2><TOKEN>/span> -expMonthspan classo>/span>span classs2>12/span> -expYearspan classo>/span>span classs2>2040/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>update-token/span> -tokenspan classo>/span>span classs2><TOKEN>/span> -expMonthspan classo>/span>span classs2>12/span> -expYearspan classo>/span>span classs2>2040/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>updateTokenExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>UpdateTokenRequest/span>span classp>{/span>span classx> /span>span classn>Token/span>span classo>:/span>span classx> /span>span classs><TOKEN>/span>span classp>,/span>span classx> /span>span classn>ExpiryMonth/span>span classo>:/span>span classx> /span>span classs>12/span>span classp>,/span>span classx> /span>span classn>ExpiryYear/span>span classo>:/span>span classx> /span>span classs>2040/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>UpdateToken/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>UpdateTokenRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>UpdateTokenRequest/span>span classp>{/span> span classn>Token/span> span classp>/span> span classs><TOKEN>/span>span classp>,/span> span classn>ExpiryMonth/span> span classp>/span> span classs>12/span>span classp>,/span> span classn>ExpiryYear/span> span classp>/span> span classs>2040/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>UpdateTokenResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>UpdateTokenAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.UpdateTokenRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.UpdateTokenResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>UpdateTokenExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>UpdateTokenRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>UpdateTokenRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setToken/span>span classo>(/span>span classs><TOKEN>/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setExpiryMonth/span>span classo>(/span>span classs>12/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setExpiryYear/span>span classo>(/span>span classs>2040/span>span classo>);/span> span classc1>// Send the request/span> span classn>UpdateTokenResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>updateToken/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>token/span> span classo>>/span> span classs1><TOKEN>/span>span classp>,/span> span classs1>expiryMonth/span> span classo>>/span> span classs1>12/span>span classp>,/span> span classs1>expiryYear/span> span classo>>/span> span classs1>2040/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>updateToken/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>token: /span>span classs1><TOKEN>/span>span classp>,/span> span classss>expiryMonth: /span>span classs1>12/span>span classp>,/span> span classss>expiryYear: /span>span classs1>2040/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>updateToken/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>token/span>span classp>:/span> span classs><TOKEN>/span>span classp>,/span> span classs>expiryMonth/span>span classp>:/span> span classs>12/span>span classp>,/span> span classs>expiryYear/span>span classp>:/span> span classs>2040/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>update_token/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>updateToken/span>span classp>({/span> span classna>token/span>span classp>:/span> span classs1><TOKEN>/span>span classp>,/span> span classna>expiryMonth/span>span classp>:/span> span classs1>12/span>span classp>,/span> span classna>expiryYear/span>span classp>:/span> span classs1>2040/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>UpdateTokenRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>token/span> span classo>/span> span classs1><TOKEN>/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>expiryMonth/span> span classo>/span> span classs1>12/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>expiryYear/span> span classo>/span> span classs1>2040/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>updateToken/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>UpdateTokenResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>token/span>span classp>/span> span classo>/span> span classs><TOKEN>/span> span classn>request/span>span classp>/span>span classs>expiryMonth/span>span classp>/span> span classo>/span> span classs>12/span> span classn>request/span>span classp>/span>span classs>expiryYear/span>span classp>/span> span classo>/span> span classs>2040/span> span classp>/span>span classn>client/span> span classnf>updateTokenWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>token/span>span classp>/span> span classo>/span> span classs><TOKEN>/span> span classn>request/span>span classp>/span>span classs>expiryMonth/span>span classp>/span> span classo>/span> span classs>12/span> span classn>request/span>span classp>/span>span classs>expiryYear/span>span classp>/span> span classo>/span> span classs>2040/span> span classn>client/span>span classo>./span>span classnf>updateToken/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>update_token_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>UpdateTokenRequest/span>span classp>{/span> span classn>token/span>span classp>:/span> span classs><TOKEN>/span>span classnf>.to_string/span>span classp>(),/span> span classn>expiry_month/span>span classp>:/span> span classs>12/span>span classnf>.to_string/span>span classp>(),/span> span classn>expiry_year/span>span classp>:/span> span classs>2040/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.update_token/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>update_token_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>token/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>token/span>span classp>:/span>span classw> /span>span classs2>VLBZHCBOKJC3OZRCLLVBOFR4RM/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************5454/span>span classp>,/span>span classw> /span>span classs2>expiryMonth/span>span classp>:/span>span classw> /span>span classs2>12/span>span classp>,/span>span classw> /span>span classs2>expiryYear/span>span classp>:/span>span classw> /span>span classs2>2040/span>span classp>,/span>span classw> /span>span classs2>paymentType/span>span classp>:/span>span classw> /span>span classs2>VISA/span>span classp>,/span>span classw> /span>span classs2>cardholderName/span>span classp>:/span>span classw> /span>span classs2>Test/Card 05/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API updates a payment token in the gateway. This can be used to update token metadata such as expiration dates, cardholder name, bank name, account holder type, account type, address, and postal code./p>h2 iddelete-token>Delete Token/h2>blockquote>p>Delete Token Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>delete-token/span> -tokenspan classo>/span>span classs2><TOKEN>/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>delete-token/span> -tokenspan classo>/span>span classs2><TOKEN>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>deleteTokenExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>DeleteTokenRequest/span>span classp>{/span>span classx> /span>span classn>Token/span>span classo>:/span>span classx> /span>span classs><TOKEN>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>DeleteToken/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>DeleteTokenRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>DeleteTokenRequest/span>span classp>{/span> span classn>Token/span> span classp>/span> span classs><TOKEN>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>DeleteTokenResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>DeleteTokenAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.DeleteTokenRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.DeleteTokenResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>DeleteTokenExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>DeleteTokenRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>DeleteTokenRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setToken/span>span classo>(/span>span classs><TOKEN>/span>span classo>);/span> span classc1>// Send the request/span> span classn>DeleteTokenResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>deleteToken/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>token/span> span classo>>/span> span classs1><TOKEN>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>deleteToken/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>token: /span>span classs1><TOKEN>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>deleteToken/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>token/span>span classp>:/span> span classs><TOKEN>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>delete_token/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>deleteToken/span>span classp>({/span> span classna>token/span>span classp>:/span> span classs1><TOKEN>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>DeleteTokenRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>token/span> span classo>/span> span classs1><TOKEN>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>deleteToken/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>DeleteTokenResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>token/span>span classp>/span> span classo>/span> span classs><TOKEN>/span> span classp>/span>span classn>client/span> span classnf>deleteTokenWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>token/span>span classp>/span> span classo>/span> span classs><TOKEN>/span> span classn>client/span>span classo>./span>span classnf>deleteToken/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>delete_token_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>DeleteTokenRequest/span>span classp>{/span> span classn>token/span>span classp>:/span> span classs><TOKEN>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.delete_token/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>delete_token_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API deletes a payment token from the gateway. Tokens are automatically deleted if they have not been usedfor a year./p>h1 idcustomer-api>Customer API/h1>p>These APIs allow developers to create and manage customer records in BlockChyp. Developers who wish to useBlockChyp for tokenized recurring payments can use tokens directly if they have their own customer managementsystem. However, BlockChyp provides additional tools for managing customers and keeping track of a customer's savedpayment tokens./p>p>In addition, if customer features are used, BlockChyp can detect a payment method associated with an existingcustomer, and return customer data with payment transactions. This can be used as a passive method to detectrepeat customers./p>h2 idupdate-customer>Update Customer/h2>blockquote>p>Update Customer Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>update-customer/span> -firstNamespan classo>/span>span classs2>Peter/span> -lastNamespan classo>/span>span classs2>Gregory/span> -companyNamespan classo>/span>span classs2>Raviga Capital/span> -emailspan classo>/span>span classs2>peter@raviga.capital/span> -smsspan classo>/span>span classs2>9136488888/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>update-customer/span> -firstNamespan classo>/span>span classs2>Peter/span> -lastNamespan classo>/span>span classs2>Gregory/span> -companyNamespan classo>/span>span classs2>Raviga Capital/span> -emailspan classo>/span>span classs2>peter@raviga.capital/span> -smsspan classo>/span>span classs2>9136488888/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>updateCustomerExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>UpdateCustomerRequest/span>span classp>{/span>span classx> /span>span classn>Customer/span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>Customer/span>span classp>{/span>span classx> /span>span classn>ID/span>span classo>:/span>span classx> /span>span classs><CUSTOMER ID>/span>span classp>,/span>span classx> /span>span classn>CustomerRef/span>span classo>:/span>span classx> /span>span classs>Customer reference string/span>span classp>,/span>span classx> /span>span classn>FirstName/span>span classo>:/span>span classx> /span>span classs>FirstName/span>span classp>,/span>span classx> /span>span classn>LastName/span>span classo>:/span>span classx> /span>span classs>LastName/span>span classp>,/span>span classx> /span>span classn>CompanyName/span>span classo>:/span>span classx> /span>span classs>Company Name/span>span classp>,/span>span classx> /span>span classn>EmailAddress/span>span classo>:/span>span classx> /span>span classs>notifications@blockchypteam.m8r.co/span>span classp>,/span>span classx> /span>span classn>SmsNumber/span>span classo>:/span>span classx> /span>span classs>(123) 123-1231/span>span classp>,/span>span classx> /span>span classp>},/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>UpdateCustomer/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>UpdateCustomerRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>UpdateCustomerRequest/span>span classp>{/span> span classn>Customer/span> span classp>/span> span classk>new/span> span classn>Customer/span> span classp>{/span> span classn>Id/span> span classp>/span> span classs><CUSTOMER ID>/span>span classp>,/span> span classn>CustomerRef/span> span classp>/span> span classs>Customer reference string/span>span classp>,/span> span classn>FirstName/span> span classp>/span> span classs>FirstName/span>span classp>,/span> span classn>LastName/span> span classp>/span> span classs>LastName/span>span classp>,/span> span classn>CompanyName/span> span classp>/span> span classs>Company Name/span>span classp>,/span> span classn>EmailAddress/span> span classp>/span> span classs>notifications@blockchypteam.m8r.co/span>span classp>,/span> span classn>SmsNumber/span> span classp>/span> span classs>(123) 123-1231/span>span classp>,/span> span classp>},/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>CustomerResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>UpdateCustomerAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.UpdateCustomerRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.CustomerResponse/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.Customer/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>UpdateCustomerExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>UpdateCustomerRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>UpdateCustomerRequest/span>span classo>();/span> span classn>Customer/span> span classn>customer/span> span classo>/span> span classk>new/span> span classn>Customer/span>span classo>();/span> span classn>customer/span>span classo>./span>span classna>setId/span>span classo>(/span>span classs><CUSTOMER ID>/span>span classo>);/span> span classn>customer/span>span classo>./span>span classna>setCustomerRef/span>span classo>(/span>span classs>Customer reference string/span>span classo>);/span> span classn>customer/span>span classo>./span>span classna>setFirstName/span>span classo>(/span>span classs>FirstName/span>span classo>);/span> span classn>customer/span>span classo>./span>span classna>setLastName/span>span classo>(/span>span classs>LastName/span>span classo>);/span> span classn>customer/span>span classo>./span>span classna>setCompanyName/span>span classo>(/span>span classs>Company Name/span>span classo>);/span> span classn>customer/span>span classo>./span>span classna>setEmailAddress/span>span classo>(/span>span classs>notifications@blockchypteam.m8r.co/span>span classo>);/span> span classn>customer/span>span classo>./span>span classna>setSmsNumber/span>span classo>(/span>span classs>(123) 123-1231/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setCustomer/span>span classo>(/span>span classn>customer/span>span classo>);/span> span classc1>// Send the request/span> span classn>CustomerResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>updateCustomer/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>customer/span> span classo>>/span> span classp>/span> span classs1>id/span> span classo>>/span> span classs1><CUSTOMER ID>/span>span classp>,/span> span classs1>customerRef/span> span classo>>/span> span classs1>Customer reference string/span>span classp>,/span> span classs1>firstName/span> span classo>>/span> span classs1>FirstName/span>span classp>,/span> span classs1>lastName/span> span classo>>/span> span classs1>LastName/span>span classp>,/span> span classs1>companyName/span> span classo>>/span> span classs1>Company Name/span>span classp>,/span> span classs1>emailAddress/span> span classo>>/span> span classs1>notifications@blockchypteam.m8r.co/span>span classp>,/span> span classs1>smsNumber/span> span classo>>/span> span classs1>(123) 123-1231/span>span classp>,/span> span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>updateCustomer/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>customer: /span>span classp>{/span> span classss>id: /span>span classs1><CUSTOMER ID>/span>span classp>,/span> span classss>customerRef: /span>span classs1>Customer reference string/span>span classp>,/span> span classss>firstName: /span>span classs1>FirstName/span>span classp>,/span> span classss>lastName: /span>span classs1>LastName/span>span classp>,/span> span classss>companyName: /span>span classs1>Company Name/span>span classp>,/span> span classss>emailAddress: /span>span classs1>notifications@blockchypteam.m8r.co/span>span classp>,/span> span classss>smsNumber: /span>span classs1>(123) 123-1231/span> span classp>}/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>updateCustomer/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>customer/span>span classp>:/span> span classp>{/span> span classs>id/span>span classp>:/span> span classs><CUSTOMER ID>/span>span classp>,/span> span classs>customerRef/span>span classp>:/span> span classs>Customer reference string/span>span classp>,/span> span classs>firstName/span>span classp>:/span> span classs>FirstName/span>span classp>,/span> span classs>lastName/span>span classp>:/span> span classs>LastName/span>span classp>,/span> span classs>companyName/span>span classp>:/span> span classs>Company Name/span>span classp>,/span> span classs>emailAddress/span>span classp>:/span> span classs>notifications@blockchypteam.m8r.co/span>span classp>,/span> span classs>smsNumber/span>span classp>:/span> span classs>(123) 123-1231/span>span classp>,/span> span classp>},/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>update_customer/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>updateCustomer/span>span classp>({/span> span classna>customer/span>span classp>:/span> span classp>{/span> span classna>id/span>span classp>:/span> span classs1><CUSTOMER ID>/span>span classp>,/span> span classna>customerRef/span>span classp>:/span> span classs1>Customer reference string/span>span classp>,/span> span classna>firstName/span>span classp>:/span> span classs1>FirstName/span>span classp>,/span> span classna>lastName/span>span classp>:/span> span classs1>LastName/span>span classp>,/span> span classna>companyName/span>span classp>:/span> span classs1>Company Name/span>span classp>,/span> span classna>emailAddress/span>span classp>:/span> span classs1>notifications@blockchypteam.m8r.co/span>span classp>,/span> span classna>smsNumber/span>span classp>:/span> span classs1>(123) 123-1231/span>span classp>,/span> span classp>},/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>UpdateCustomerRequest/span>span classp>();/span>span classkd>const/span> span classnx>customer/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>Customer/span>span classp>();/span>span classnx>customer/span>span classp>./span>span classnx>id/span> span classo>/span> span classs1><CUSTOMER ID>/span>span classp>;/span>span classnx>customer/span>span classp>./span>span classnx>customerRef/span> span classo>/span> span classs1>Customer reference string/span>span classp>;/span>span classnx>customer/span>span classp>./span>span classnx>firstName/span> span classo>/span> span classs1>FirstName/span>span classp>;/span>span classnx>customer/span>span classp>./span>span classnx>lastName/span> span classo>/span> span classs1>LastName/span>span classp>;/span>span classnx>customer/span>span classp>./span>span classnx>companyName/span> span classo>/span> span classs1>Company Name/span>span classp>;/span>span classnx>customer/span>span classp>./span>span classnx>emailAddress/span> span classo>/span> span classs1>notifications@blockchypteam.m8r.co/span>span classp>;/span>span classnx>customer/span>span classp>./span>span classnx>smsNumber/span> span classo>/span> span classs1>(123) 123-1231/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>customer/span> span classo>/span> span classnx>customer/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>updateCustomer/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>CustomerResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>var/span> span classn>customer/span>span classo>:/span> span classp>/span>span classnf>String/span>span classp>:/span>span classn>Any/span>span classp>/span> span classo>/span> span classp>/span>span classo>:/span>span classp>/span> span classn>customer/span>span classp>/span>span classs>id/span>span classp>/span> span classo>/span> span classs><CUSTOMER ID>/span> span classn>customer/span>span classp>/span>span classs>customerRef/span>span classp>/span> span classo>/span> span classs>Customer reference string/span> span classn>customer/span>span classp>/span>span classs>firstName/span>span classp>/span> span classo>/span> span classs>FirstName/span> span classn>customer/span>span classp>/span>span classs>lastName/span>span classp>/span> span classo>/span> span classs>LastName/span> span classn>customer/span>span classp>/span>span classs>companyName/span>span classp>/span> span classo>/span> span classs>Company Name/span> span classn>customer/span>span classp>/span>span classs>emailAddress/span>span classp>/span> span classo>/span> span classs>notifications@blockchypteam.m8r.co/span> span classn>customer/span>span classp>/span>span classs>smsNumber/span>span classp>/span> span classo>/span> span classs>(123) 123-1231/span> span classn>request/span>span classp>/span>span classs>customer/span>span classp>/span> span classo>/span> span classn>customer/span> span classp>/span>span classn>client/span> span classnf>updateCustomerWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@customer/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@customer/span>span classp>)/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classk>var/span> span classnv>customer/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>customer/span>span classp>/span>span classs>id/span>span classp>/span> span classo>/span> span classs><CUSTOMER ID>/span> span classn>customer/span>span classp>/span>span classs>customerRef/span>span classp>/span> span classo>/span> span classs>Customer reference string/span> span classn>customer/span>span classp>/span>span classs>firstName/span>span classp>/span> span classo>/span> span classs>FirstName/span> span classn>customer/span>span classp>/span>span classs>lastName/span>span classp>/span> span classo>/span> span classs>LastName/span> span classn>customer/span>span classp>/span>span classs>companyName/span>span classp>/span> span classo>/span> span classs>Company Name/span> span classn>customer/span>span classp>/span>span classs>emailAddress/span>span classp>/span> span classo>/span> span classs>notifications@blockchypteam.m8r.co/span> span classn>customer/span>span classp>/span>span classs>smsNumber/span>span classp>/span> span classo>/span> span classs>(123) 123-1231/span> span classn>request/span>span classp>/span>span classs>customer/span>span classp>/span> span classo>/span> span classn>customer/span> span classn>client/span>span classo>./span>span classnf>updateCustomer/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classkt>NSLog/span>span classp>(/span>span classs>customer/span> span classo>+/span> span classs>: /span> span classo>+/span> span classp>(/span>span classn>response/span>span classp>/span>span classs>customer/span>span classp>/span> span classk>as?/span> span classkt>String/span>span classp>)/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>update_customer_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>UpdateCustomerRequest/span>span classp>{/span> span classn>customer/span>span classp>:/span> span classnn>blockchyp/span>span classp>::/span>span classn>Customer/span>span classp>{/span> span classn>id/span>span classp>:/span> span classs><CUSTOMER ID>/span>span classnf>.to_string/span>span classp>(),/span> span classn>customer_ref/span>span classp>:/span> span classs>Customer reference string/span>span classnf>.to_string/span>span classp>(),/span> span classn>first_name/span>span classp>:/span> span classs>FirstName/span>span classnf>.to_string/span>span classp>(),/span> span classn>last_name/span>span classp>:/span> span classs>LastName/span>span classnf>.to_string/span>span classp>(),/span> span classn>company_name/span>span classp>:/span> span classs>Company Name/span>span classnf>.to_string/span>span classp>(),/span> span classn>email_address/span>span classp>:/span> span classs>notifications@blockchypteam.m8r.co/span>span classnf>.to_string/span>span classp>(),/span> span classn>sms_number/span>span classp>:/span> span classs>(123) 123-1231/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>},/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.update_customer/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>update_customer_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>customer/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>P7UV23UOEII6VJCUAJBKYEIAAI/span>span classp>,/span>span classw> /span>span classs2>customerRef/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>firstName/span>span classp>:/span>span classw> /span>span classs2>Peter/span>span classp>,/span>span classw> /span>span classs2>lastName/span>span classp>:/span>span classw> /span>span classs2>Gregory/span>span classp>,/span>span classw> /span>span classs2>companyName/span>span classp>:/span>span classw> /span>span classs2>Raviga Capital/span>span classp>,/span>span classw> /span>span classs2>emailAddress/span>span classp>:/span>span classw> /span>span classs2>peter@raviga.capital/span>span classp>,/span>span classw> /span>span classs2>smsNumber/span>span classp>:/span>span classw> /span>span classs2>9136488888/span>span classp>,/span>span classw> /span>span classs2>paymentMethods/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API adds or updates a customer record./p>p>If you pass in customer information including code>firstName/code>, code>lastName/code>, code>email/code>,or code>sms/code> without any Customer ID or Customer Ref, a new record willbe created./p>p>If you pass in code>customerRef/code> and code>customerId/code>, the customer record will be updatedif it exists./p>p>strong>Customer Ref/strong>/p>p>The code>customerRef/code> field is optional, but highly recommended as this allows youto use your own customer identifiers instead of storing BlockChyp's Customer IDsin your systems./p>p>strong>Creating Customer Records With Payment Transactions/strong>/p>p>If you have customer information available at the time a payment transaction isexecuted, you can pass all the same customer information directly into a payment transaction. BlockChypwill create a customer record at the same time payment is captured. The advantage of this approach isthat the customer's payment card is automatically associated with the customer record in a single step.If the customer uses the payment card in the future, the customer data will automaticallybe returned. You won't need to ask the customer to provide any additional information./p>h2 idretrieve-customer>Retrieve Customer/h2>blockquote>p>Retrieve Customer Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>get-customer/span> -customerIdspan classo>/span>span classs2><CUSTOMER ID>/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>get-customer/span> -customerIdspan classo>/span>span classs2><CUSTOMER ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>customerExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>CustomerRequest/span>span classp>{/span>span classx> /span>span classn>CustomerID/span>span classo>:/span>span classx> /span>span classs><CUSTOMER ID>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>Customer/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>CustomerRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>CustomerRequest/span>span classp>{/span> span classn>CustomerId/span> span classp>/span> span classs><CUSTOMER ID>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>CustomerResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>CustomerAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.CustomerRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.CustomerResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>CustomerExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>CustomerRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>CustomerRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setCustomerId/span>span classo>(/span>span classs><CUSTOMER ID>/span>span classo>);/span> span classc1>// Send the request/span> span classn>CustomerResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>customer/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>customerId/span> span classo>>/span> span classs1><CUSTOMER ID>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>customer/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>customerId: /span>span classs1><CUSTOMER ID>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>customer/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>customerId/span>span classp>:/span> span classs><CUSTOMER ID>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>customer/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>customer/span>span classp>({/span> span classna>customerId/span>span classp>:/span> span classs1><CUSTOMER ID>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>CustomerRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>customerId/span> span classo>/span> span classs1><CUSTOMER ID>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>customer/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>CustomerResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>customerId/span>span classp>/span> span classo>/span> span classs><CUSTOMER ID>/span> span classp>/span>span classn>client/span> span classnf>customerWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@customer/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@customer/span>span classp>)/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>customerId/span>span classp>/span> span classo>/span> span classs><CUSTOMER ID>/span> span classn>client/span>span classo>./span>span classnf>customer/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classkt>NSLog/span>span classp>(/span>span classs>customer/span> span classo>+/span> span classs>: /span> span classo>+/span> span classp>(/span>span classn>response/span>span classp>/span>span classs>customer/span>span classp>/span> span classk>as?/span> span classkt>String/span>span classp>)/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>customer_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>CustomerRequest/span>span classp>{/span> span classn>customer_id/span>span classp>:/span> span classs><CUSTOMER ID>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.customer/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>customer_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>customer/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>P7UV23UOEII6VJCUAJBKYEIAAI/span>span classp>,/span>span classw> /span>span classs2>customerRef/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>firstName/span>span classp>:/span>span classw> /span>span classs2>Peter/span>span classp>,/span>span classw> /span>span classs2>lastName/span>span classp>:/span>span classw> /span>span classs2>Gregory/span>span classp>,/span>span classw> /span>span classs2>companyName/span>span classp>:/span>span classw> /span>span classs2>Raviga Capital/span>span classp>,/span>span classw> /span>span classs2>emailAddress/span>span classp>:/span>span classw> /span>span classs2>peter@raviga.capital/span>span classp>,/span>span classw> /span>span classs2>smsNumber/span>span classp>:/span>span classw> /span>span classs2>9136488888/span>span classp>,/span>span classw> /span>span classs2>paymentMethods/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>token/span>span classp>:/span>span classw> /span>span classs2>JFDODVEUTFIXIKG5G4NWQFLKV4/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************0010/span>span classp>,/span>span classw> /span>span classs2>expiryMonth/span>span classp>:/span>span classw> /span>span classs2>12/span>span classp>,/span>span classw> /span>span classs2>expiryYear/span>span classp>:/span>span classw> /span>span classs2>22/span>span classp>,/span>span classw> /span>span classs2>paymentType/span>span classp>:/span>span classw> /span>span classs2>VISA/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>With this API, you can retrieve detailed information about a customer record, including saved paymentmethods if available./p>p>Customers can be looked up by code>customerId/code> or code>customerRef/code>./p>aside classwarning>This endpoint is the only way to pull down saved payment methods for a customer record.Customer search results do not include saved payment methods./aside>h2 idsearch-customer>Search Customer/h2>blockquote>p>Search Customer Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>search-customer/span> -queryspan classo>/span>span classs2>Peter/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>search-customer/span> -queryspan classo>/span>span classs2>Peter/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>customerSearchExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>CustomerSearchRequest/span>span classp>{/span>span classx> /span>span classn>Query/span>span classo>:/span>span classx> /span>span classs>(123) 123-1234/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>CustomerSearch/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>CustomerSearchRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>CustomerSearchRequest/span>span classp>{/span> span classn>Query/span> span classp>/span> span classs>(123) 123-1234/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>CustomerSearchResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>CustomerSearchAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.CustomerSearchRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.CustomerSearchResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>CustomerSearchExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>CustomerSearchRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>CustomerSearchRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setQuery/span>span classo>(/span>span classs>(123) 123-1234/span>span classo>);/span> span classc1>// Send the request/span> span classn>CustomerSearchResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>customerSearch/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>query/span> span classo>>/span> span classs1>(123) 123-1234/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>customerSearch/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>query: /span>span classs1>(123) 123-1234/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>customerSearch/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>query/span>span classp>:/span> span classs>(123) 123-1234/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>customer_search/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>customerSearch/span>span classp>({/span> span classna>query/span>span classp>:/span> span classs1>(123) 123-1234/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>CustomerSearchRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>query/span> span classo>/span> span classs1>(123) 123-1234/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>customerSearch/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>CustomerSearchResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>query/span>span classp>/span> span classo>/span> span classs>(123) 123-1234/span> span classp>/span>span classn>client/span> span classnf>customerSearchWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@customers/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@customers/span>span classp>)/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>query/span>span classp>/span> span classo>/span> span classs>(123) 123-1234/span> span classn>client/span>span classo>./span>span classnf>customerSearch/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classkt>NSLog/span>span classp>(/span>span classs>customers/span> span classo>+/span> span classs>: /span> span classo>+/span> span classp>(/span>span classn>response/span>span classp>/span>span classs>customers/span>span classp>/span> span classk>as?/span> span classkt>String/span>span classp>)/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>customer_search_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>CustomerSearchRequest/span>span classp>{/span> span classn>query/span>span classp>:/span> span classs>(123) 123-1234/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.customer_search/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>customer_search_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>customers/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>EWEMCMDO2YI6VHR6AJBKYEIAAM/span>span classp>,/span>span classw> /span>span classs2>customerRef/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>firstName/span>span classp>:/span>span classw> /span>span classs2>Peter/span>span classp>,/span>span classw> /span>span classs2>lastName/span>span classp>:/span>span classw> /span>span classs2>Pan/span>span classp>,/span>span classw> /span>span classs2>companyName/span>span classp>:/span>span classw> /span>span classs2>Lost Boys/span>span classp>,/span>span classw> /span>span classs2>emailAddress/span>span classp>:/span>span classw> /span>span classs2>peter@blockchyp.com/span>span classp>,/span>span classw> /span>span classs2>smsNumber/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>paymentMethods/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>P7UV23UOEII6VJCUAJBKYEIAAI/span>span classp>,/span>span classw> /span>span classs2>customerRef/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>firstName/span>span classp>:/span>span classw> /span>span classs2>Peter/span>span classp>,/span>span classw> /span>span classs2>lastName/span>span classp>:/span>span classw> /span>span classs2>Gregory/span>span classp>,/span>span classw> /span>span classs2>companyName/span>span classp>:/span>span classw> /span>span classs2>Raviga Capital/span>span classp>,/span>span classw> /span>span classs2>emailAddress/span>span classp>:/span>span classw> /span>span classs2>peter@raviga.capital/span>span classp>,/span>span classw> /span>span classs2>smsNumber/span>span classp>:/span>span classw> /span>span classs2>9136488888/span>span classp>,/span>span classw> /span>span classs2>paymentMethods/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API searches the customer database and returns matching results./p>p>Use code>query/code> to pass in a search string and the system will return all results whosefirst or last names contain the query string./p>aside classwarning>Note that saved payment methods are not returned with search results. Use theRetrieve Customer API to pull down save payment methods for specific customerrecord./aside>h2 iddelete-customer>Delete Customer/h2>blockquote>p>Delete Customer Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>delete-customer/span> -customerIdspan classo>/span>span classs2><CUSTOMER ID>/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>delete-customer/span> -customerIdspan classo>/span>span classs2><CUSTOMER ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>deleteCustomerExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>DeleteCustomerRequest/span>span classp>{/span>span classx> /span>span classn>CustomerID/span>span classo>:/span>span classx> /span>span classs><CUSTOMER ID>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>DeleteCustomer/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>DeleteCustomerRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>DeleteCustomerRequest/span>span classp>{/span> span classn>CustomerId/span> span classp>/span> span classs><CUSTOMER ID>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>DeleteCustomerResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>DeleteCustomerAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.DeleteCustomerRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.DeleteCustomerResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>DeleteCustomerExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>DeleteCustomerRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>DeleteCustomerRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setCustomerId/span>span classo>(/span>span classs><CUSTOMER ID>/span>span classo>);/span> span classc1>// Send the request/span> span classn>DeleteCustomerResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>deleteCustomer/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>customerId/span> span classo>>/span> span classs1><CUSTOMER ID>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>deleteCustomer/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>customerId: /span>span classs1><CUSTOMER ID>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>deleteCustomer/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>customerId/span>span classp>:/span> span classs><CUSTOMER ID>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>delete_customer/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>deleteCustomer/span>span classp>({/span> span classna>customerId/span>span classp>:/span> span classs1><CUSTOMER ID>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>DeleteCustomerRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>customerId/span> span classo>/span> span classs1><CUSTOMER ID>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>deleteCustomer/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>DeleteCustomerResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>customerId/span>span classp>/span> span classo>/span> span classs><CUSTOMER ID>/span> span classp>/span>span classn>client/span> span classnf>deleteCustomerWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>customerId/span>span classp>/span> span classo>/span> span classs><CUSTOMER ID>/span> span classn>client/span>span classo>./span>span classnf>deleteCustomer/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>delete_customer_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>DeleteCustomerRequest/span>span classp>{/span> span classn>customer_id/span>span classp>:/span> span classs><CUSTOMER ID>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.delete_customer/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>delete_customer_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API deletes a customer record./p>h1 idsurvey-api>Survey API/h1>p>These APIs are used to work with post-transaction surveys and survey data./p>p>Merchants can optionally configure scaled (1-5) or yes/no questions that can be presented to consumersafter every approved Charge and Preauth transaction. Surveys do not require any custom programming andmerchants can simply configure them without the point-of-sale system needing any additional customization./p>p>However, these APIs allow point-of-sale or third-party system developers to integrate survey question configurationor result visualization into their own systems./p>h2 idlist-questions>List Questions/h2>blockquote>p>List Questions Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>survey-questions/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>survey-questions/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>surveyQuestionsExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>SurveyQuestionRequest/span>span classp>{}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>SurveyQuestions/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>SurveyQuestionRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>SurveyQuestionRequest/span>span classp>{/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>SurveyQuestionResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>SurveyQuestionsAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.SurveyQuestionRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.SurveyQuestionResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>SurveyQuestionsExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>SurveyQuestionRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>SurveyQuestionRequest/span>span classo>();/span> span classc1>// Send the request/span> span classn>SurveyQuestionResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>surveyQuestions/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>surveyQuestions/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>surveyQuestions/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>survey_questions/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>surveyQuestions/span>span classp>({/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>SurveyQuestionRequest/span>span classp>();/span>span classnx>client/span>span classp>./span>span classnx>surveyQuestions/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>SurveyQuestionResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classp>/span>span classn>client/span> span classnf>surveyQuestionsWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>client/span>span classo>./span>span classnf>surveyQuestions/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>survey_questions_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>SurveyQuestionRequest/span>span classp>{/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.survey_questions/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>survey_questions_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>results/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>OXTTEBWWXYI6ZJFEVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>ordinal/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>enabled/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>questionText/span>span classp>:/span>span classw> /span>span classs2>Would you shop here again?/span>span classp>,/span>span classw> /span>span classs2>questionType/span>span classp>:/span>span classw> /span>span classs2>yes_no/span>span classp>,/span>span classw> /span>span classs2>responses/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Survey Management/li>/ul>p>This API returns all survey questions in the order in which they would be presented on the terminal./p>p>All questions are returned, whether enabled or disabled./p>h2 idquestion-details>Question Details/h2>blockquote>p>Question Details Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>survey-question/span> -questionIdspan classo>/span>span classs2><QUESTION ID>/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>survey-question/span> -questionIdspan classo>/span>span classs2><QUESTION ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>surveyQuestionExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>SurveyQuestionRequest/span>span classp>{/span>span classx> /span>span classn>QuestionID/span>span classo>:/span>span classx> /span>span classs><QUESTION ID>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>SurveyQuestion/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>SurveyQuestionRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>SurveyQuestionRequest/span>span classp>{/span> span classn>QuestionId/span> span classp>/span> span classs><QUESTION ID>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>SurveyQuestion/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>SurveyQuestionAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.SurveyQuestionRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.SurveyQuestion/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>SurveyQuestionExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>SurveyQuestionRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>SurveyQuestionRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setQuestionId/span>span classo>(/span>span classs><QUESTION ID>/span>span classo>);/span> span classc1>// Send the request/span> span classn>SurveyQuestion/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>surveyQuestion/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>questionId/span> span classo>>/span> span classs1><QUESTION ID>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>surveyQuestion/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>questionId: /span>span classs1><QUESTION ID>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>surveyQuestion/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>questionId/span>span classp>:/span> span classs><QUESTION ID>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>survey_question/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>surveyQuestion/span>span classp>({/span> span classna>questionId/span>span classp>:/span> span classs1><QUESTION ID>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>SurveyQuestionRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>questionId/span> span classo>/span> span classs1><QUESTION ID>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>surveyQuestion/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>SurveyQuestion/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>questionId/span>span classp>/span> span classo>/span> span classs><QUESTION ID>/span> span classp>/span>span classn>client/span> span classnf>surveyQuestionWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>questionId/span>span classp>/span> span classo>/span> span classs><QUESTION ID>/span> span classn>client/span>span classo>./span>span classnf>surveyQuestion/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>survey_question_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>SurveyQuestionRequest/span>span classp>{/span> span classn>question_id/span>span classp>:/span> span classs><QUESTION ID>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.survey_question/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>survey_question_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>OXTTEBWWXYI6ZJFEVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>ordinal/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>enabled/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>questionText/span>span classp>:/span>span classw> /span>span classs2>Are you there?/span>span classp>,/span>span classw> /span>span classs2>questionType/span>span classp>:/span>span classw> /span>span classs2>yes_no/span>span classp>,/span>span classw> /span>span classs2>responses/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Survey Management/li>/ul>p>This API returns a single survey question with response data. code>questionId/code> is required./p>h2 idupdate-question>Update Question/h2>blockquote>p>Update Question Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>update-survey-question/span> -questionIdspan classo>/span>span classs2><QUESTION ID>/span> -questionTypespan classo>/span>span classs2>yes_no/span> -ordinalspan classo>/span>span classs2>1/span> -enabled -questionTextspan classo>/span>span classs2>Would you shop here again?/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>update-survey-question/span> -questionIdspan classo>/span>span classs2><QUESTION ID>/span> -questionTypespan classo>/span>span classs2>yes_no/span> -ordinalspan classo>/span>span classs2>1/span> -enabled -questionTextspan classo>/span>span classs2>Would you shop here again?/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>updateSurveyQuestionExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>SurveyQuestion/span>span classp>{/span>span classx> /span>span classn>ID/span>span classo>:/span>span classx> /span>span classs><QUESTION ID>/span>span classp>,/span>span classx> /span>span classn>Ordinal/span>span classo>:/span>span classx> /span>span classm>1/span>span classp>,/span>span classx> /span>span classn>QuestionText/span>span classo>:/span>span classx> /span>span classs>Would you shop here again?/span>span classp>,/span>span classx> /span>span classn>QuestionType/span>span classo>:/span>span classx> /span>span classs>yes_no/span>span classp>,/span>span classx> /span>span classn>Enabled/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>UpdateSurveyQuestion/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>SurveyQuestion/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>SurveyQuestion/span>span classp>{/span> span classn>Id/span> span classp>/span> span classs><QUESTION ID>/span>span classp>,/span> span classn>Ordinal/span> span classp>/span> span classm>1/span>span classp>,/span> span classn>QuestionText/span> span classp>/span> span classs>Would you shop here again?/span>span classp>,/span> span classn>QuestionType/span> span classp>/span> span classs>yes_no/span>span classp>,/span> span classn>Enabled/span> span classp>/span> span classk>true/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>SurveyQuestion/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>UpdateSurveyQuestionAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.SurveyQuestion/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.SurveyQuestion/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>UpdateSurveyQuestionExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>SurveyQuestion/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>SurveyQuestion/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setId/span>span classo>(/span>span classs><QUESTION ID>/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setOrdinal/span>span classo>(/span>span classmi>1/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setQuestionText/span>span classo>(/span>span classs>Would you shop here again?/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setQuestionType/span>span classo>(/span>span classs>yes_no/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setEnabled/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classc1>// Send the request/span> span classn>SurveyQuestion/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>updateSurveyQuestion/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>id/span> span classo>>/span> span classs1><QUESTION ID>/span>span classp>,/span> span classs1>ordinal/span> span classo>>/span> span classmi>1/span>span classp>,/span> span classs1>questionText/span> span classo>>/span> span classs1>Would you shop here again?/span>span classp>,/span> span classs1>questionType/span> span classo>>/span> span classs1>yes_no/span>span classp>,/span> span classs1>enabled/span> span classo>>/span> span classkc>true/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>updateSurveyQuestion/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>id: /span>span classs1><QUESTION ID>/span>span classp>,/span> span classss>ordinal: /span>span classmi>1/span>span classp>,/span> span classss>questionText: /span>span classs1>Would you shop here again?/span>span classp>,/span> span classss>questionType: /span>span classs1>yes_no/span>span classp>,/span> span classss>enabled: /span>span classkp>true/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>updateSurveyQuestion/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>id/span>span classp>:/span> span classs><QUESTION ID>/span>span classp>,/span> span classs>ordinal/span>span classp>:/span> span classmi>1/span>span classp>,/span> span classs>questionText/span>span classp>:/span> span classs>Would you shop here again?/span>span classp>,/span> span classs>questionType/span>span classp>:/span> span classs>yes_no/span>span classp>,/span> span classs>enabled/span>span classp>:/span> span classbp>True/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>update_survey_question/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>updateSurveyQuestion/span>span classp>({/span> span classna>id/span>span classp>:/span> span classs1><QUESTION ID>/span>span classp>,/span> span classna>ordinal/span>span classp>:/span> span classmi>1/span>span classp>,/span> span classna>questionText/span>span classp>:/span> span classs1>Would you shop here again?/span>span classp>,/span> span classna>questionType/span>span classp>:/span> span classs1>yes_no/span>span classp>,/span> span classna>enabled/span>span classp>:/span> span classkc>true/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>SurveyQuestion/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>id/span> span classo>/span> span classs1><QUESTION ID>/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>ordinal/span> span classo>/span> span classmi>1/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>questionText/span> span classo>/span> span classs1>Would you shop here again?/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>questionType/span> span classo>/span> span classs1>yes_no/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>enabled/span> span classo>/span> span classkc>true/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>updateSurveyQuestion/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>SurveyQuestion/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>id/span>span classp>/span> span classo>/span> span classs><QUESTION ID>/span> span classn>request/span>span classp>/span>span classs>ordinal/span>span classp>/span> span classo>/span> span classmi>1/span> span classn>request/span>span classp>/span>span classs>questionText/span>span classp>/span> span classo>/span> span classs>Would you shop here again?/span> span classn>request/span>span classp>/span>span classs>questionType/span>span classp>/span> span classo>/span> span classs>yes_no/span> span classn>request/span>span classp>/span>span classs>enabled/span>span classp>/span> span classo>/span> span classnb>true/span> span classp>/span>span classn>client/span> span classnf>updateSurveyQuestionWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>id/span>span classp>/span> span classo>/span> span classs><QUESTION ID>/span> span classn>request/span>span classp>/span>span classs>ordinal/span>span classp>/span> span classo>/span> span classmi>1/span> span classn>request/span>span classp>/span>span classs>questionText/span>span classp>/span> span classo>/span> span classs>Would you shop here again?/span> span classn>request/span>span classp>/span>span classs>questionType/span>span classp>/span> span classo>/span> span classs>yes_no/span> span classn>request/span>span classp>/span>span classs>enabled/span>span classp>/span> span classo>/span> span classkc>true/span> span classn>client/span>span classo>./span>span classnf>updateSurveyQuestion/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>update_survey_question_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>SurveyQuestion/span>span classp>{/span> span classn>id/span>span classp>:/span> span classs><QUESTION ID>/span>span classnf>.to_string/span>span classp>(),/span> span classn>ordinal/span>span classp>:/span> span classmi>1/span>span classp>,/span> span classn>question_text/span>span classp>:/span> span classs>Would you shop here again?/span>span classnf>.to_string/span>span classp>(),/span> span classn>question_type/span>span classp>:/span> span classs>yes_no/span>span classnf>.to_string/span>span classp>(),/span> span classn>enabled/span>span classp>:/span> span classk>true/span>span classp>,/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.update_survey_question/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>update_survey_question_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>JUQEMPW3QUI6ZAK7VTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>ordinal/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>enabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>questionText/span>span classp>:/span>span classw> /span>span classs2>Would you shop here again?/span>span classp>,/span>span classw> /span>span classs2>questionType/span>span classp>:/span>span classw> /span>span classs2>yes_no/span>span classp>,/span>span classw> /span>span classs2>responses/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Survey Management/li>/ul>p>This API updates or creates survey questions. code>questionText/code> and code>questionType/code> are required fields. The following values are valid for code>questionType/code>./p>ul>li>strong>yes_no:/strong> Use for simple yes or no questions./li>li>strong>scaled:/strong> Displays the question with buttons that allow the customer to respond with values from 1 through 5./li>/ul>p>Questions are disabled by default. Pass in code>enabled/code> to enable a question./p>p>The code>ordinal/code> field is used to control the sequence of questions when multiple questions are enabled. We recommend keepingthe number of questions minimal./p>h2 iddelete-question>Delete Question/h2>blockquote>p>Delete Question Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>delete-survey-question/span> -questionIdspan classo>/span>span classs2><QUESTION ID>/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>delete-survey-question/span> -questionIdspan classo>/span>span classs2><QUESTION ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>deleteSurveyQuestionExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>SurveyQuestionRequest/span>span classp>{/span>span classx> /span>span classn>QuestionID/span>span classo>:/span>span classx> /span>span classs><QUESTION ID>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>DeleteSurveyQuestion/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>SurveyQuestionRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>SurveyQuestionRequest/span>span classp>{/span> span classn>QuestionId/span> span classp>/span> span classs><QUESTION ID>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>Acknowledgement/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>DeleteSurveyQuestionAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.SurveyQuestionRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.Acknowledgement/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>DeleteSurveyQuestionExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>SurveyQuestionRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>SurveyQuestionRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setQuestionId/span>span classo>(/span>span classs><QUESTION ID>/span>span classo>);/span> span classc1>// Send the request/span> span classn>Acknowledgement/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>deleteSurveyQuestion/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>questionId/span> span classo>>/span> span classs1><QUESTION ID>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>deleteSurveyQuestion/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>questionId: /span>span classs1><QUESTION ID>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>deleteSurveyQuestion/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>questionId/span>span classp>:/span> span classs><QUESTION ID>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>delete_survey_question/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>deleteSurveyQuestion/span>span classp>({/span> span classna>questionId/span>span classp>:/span> span classs1><QUESTION ID>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>SurveyQuestionRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>questionId/span> span classo>/span> span classs1><QUESTION ID>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>deleteSurveyQuestion/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>Acknowledgement/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>questionId/span>span classp>/span> span classo>/span> span classs><QUESTION ID>/span> span classp>/span>span classn>client/span> span classnf>deleteSurveyQuestionWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>questionId/span>span classp>/span> span classo>/span> span classs><QUESTION ID>/span> span classn>client/span>span classo>./span>span classnf>deleteSurveyQuestion/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>delete_survey_question_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>SurveyQuestionRequest/span>span classp>{/span> span classn>question_id/span>span classp>:/span> span classs><QUESTION ID>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.delete_survey_question/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>delete_survey_question_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Survey Management/li>/ul>p>This API deletes a survey question. code>questionId/code> is a required parameter./p>h2 idsurvey-results>Survey Results/h2>blockquote>p>Survey Results Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>survey-results/span> -questionIdspan classo>/span>span classs2><QUESTION ID>/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>survey-results/span> -questionIdspan classo>/span>span classs2><QUESTION ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>surveyResultsExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>SurveyResultsRequest/span>span classp>{/span>span classx> /span>span classn>QuestionID/span>span classo>:/span>span classx> /span>span classs><QUESTION ID>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>SurveyResults/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>SurveyResultsRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>SurveyResultsRequest/span>span classp>{/span> span classn>QuestionId/span> span classp>/span> span classs><QUESTION ID>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>SurveyQuestion/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>SurveyResultsAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.SurveyResultsRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.SurveyQuestion/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>SurveyResultsExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>SurveyResultsRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>SurveyResultsRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setQuestionId/span>span classo>(/span>span classs><QUESTION ID>/span>span classo>);/span> span classc1>// Send the request/span> span classn>SurveyQuestion/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>surveyResults/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>questionId/span> span classo>>/span> span classs1><QUESTION ID>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>surveyResults/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>questionId: /span>span classs1><QUESTION ID>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>surveyResults/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>questionId/span>span classp>:/span> span classs><QUESTION ID>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>survey_results/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>surveyResults/span>span classp>({/span> span classna>questionId/span>span classp>:/span> span classs1><QUESTION ID>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>SurveyResultsRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>questionId/span> span classo>/span> span classs1><QUESTION ID>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>surveyResults/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>SurveyQuestion/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>questionId/span>span classp>/span> span classo>/span> span classs><QUESTION ID>/span> span classp>/span>span classn>client/span> span classnf>surveyResultsWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>questionId/span>span classp>/span> span classo>/span> span classs><QUESTION ID>/span> span classn>client/span>span classo>./span>span classnf>surveyResults/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>survey_results_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>SurveyResultsRequest/span>span classp>{/span> span classn>question_id/span>span classp>:/span> span classs><QUESTION ID>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.survey_results/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>survey_results_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>OXTTEBWWXYI6ZJFEVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>ordinal/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>enabled/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>questionText/span>span classp>:/span>span classw> /span>span classs2>Are you there?/span>span classp>,/span>span classw> /span>span classs2>questionType/span>span classp>:/span>span classw> /span>span classs2>yes_no/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>200/span>span classp>,/span>span classw> /span>span classs2>responseCount/span>span classp>:/span>span classw> /span>span classmi>100/span>span classp>,/span>span classw> /span>span classs2>responseRate/span>span classp>:/span>span classw> /span>span classmf>0.5/span>span classp>,/span>span classw> /span>span classs2>responses/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>answerKey/span>span classp>:/span>span classw> /span>span classs2>0/span>span classp>,/span>span classw> /span>span classs2>answerDescription/span>span classp>:/span>span classw> /span>span classs2>No/span>span classp>,/span>span classw> /span>span classs2>responseCount/span>span classp>:/span>span classw> /span>span classmi>50/span>span classp>,/span>span classw> /span>span classs2>responsePercentage/span>span classp>:/span>span classw> /span>span classmf>0.5/span>span classp>,/span>span classw> /span>span classs2>averageTransaction/span>span classp>:/span>span classw> /span>span classmf>45.56/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>answerKey/span>span classp>:/span>span classw> /span>span classs2>1/span>span classp>,/span>span classw> /span>span classs2>answerDescription/span>span classp>:/span>span classw> /span>span classs2>Yes/span>span classp>,/span>span classw> /span>span classs2>responseCount/span>span classp>:/span>span classw> /span>span classmi>50/span>span classp>,/span>span classw> /span>span classs2>responsePercentage/span>span classp>:/span>span classw> /span>span classmf>0.5/span>span classp>,/span>span classw> /span>span classs2>averageTransaction/span>span classp>:/span>span classw> /span>span classmf>23.45/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Survey Management/li>/ul>p>This API returns survey results for a single question./p>p>The results returned include the response rate, which is the percentage of transactions after whichthe consumer provided an answer./p>p>The code>responses/code> array breaks down the results by answer, providing the total number of responses,the answer's percentage of the total, and the average transaction amount associated with a specificanswer./p>p>By default, all results based on all responses are returned. However, developers may optionally provide code>startDate/code> and code>endDate/code> parameters to return only responses provided between certain dates./p>p>code>startDate/code> and code>endDate/code> can be provided in MM/DD/YYYY or YYYY-MM-DD format./p>h1 idmedia-and-branding-api>Media and Branding API/h1>p>BlockChyp has a sophisticated terminal media and branding control platform. Terminals can be configured todisplay logos, images, videos, and slide shows when a terminal is idle. Branding assets can be configuredat the partner, organization, and merchant level with fine-grained hour-by-hour schedules, if desired. /p>p>Conceptually, all branding and media start with the media library. Merchants, Partners, and Organizations canupload images or video and build branding assets from uploaded media./p>p>Slide shows can combine images from the media library into a timed loop of repeating images./p>p>Branding Assets can then be used to combine media or slide shows with priority and timing rules to create what we call the Terminal Branding Stack./p>p>We call a group of branding assets the em>Terminal Branding Stack/em> because there are implicit rules about which branding assets take priority. For example, a merchant with no branding assets configured will inherit the branding rules from any organization to which the merchant may belong. If the merchant doesn't belong to an organization or the organization has no branding rules configured, then the system will defer to branding defaults established by the point-of-sale or software partner that owns the merchant./p>p>This feature enables partners and organizations (multi-store operators and large national chains) to configure brandingfor potentially thousands of terminals from a single interface./p>p>Terminal Branding can also be configured at the individual terminal level and a merchant's terminal fleet can be broken into groups and branding configured at the group level. Branding configured at the terminallevel will always override branding from any higher level group./p>p>The order of priority for the Terminal Branding Stack is given below./p>ul>li>Terminal/li>li>Terminal Group/li>li>Merchant/li>li>Organization (Region, Chain, etc)/li>li>Partner/li>li>BlockChyp Default Logo/li>/ul>h2 idmedia-library>Media Library/h2>blockquote>p>Media Library Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>media/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>media/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>mediaExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>MediaRequest/span>span classp>{}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>Media/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>MediaRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>MediaRequest/span>span classp>{/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>MediaLibraryResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>MediaAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.MediaRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.MediaLibraryResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>MediaExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>MediaRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>MediaRequest/span>span classo>();/span> span classc1>// Send the request/span> span classn>MediaLibraryResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>media/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>media/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>media/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>media/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>media/span>span classp>({/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>MediaRequest/span>span classp>();/span>span classnx>client/span>span classp>./span>span classnx>media/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>MediaLibraryResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classp>/span>span classn>client/span> span classnf>mediaWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>client/span>span classo>./span>span classnf>media/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>media_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>MediaRequest/span>span classp>{/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.media/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>media_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>maxResults/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>startIndex/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>resultCount/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>results/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>DEQZQ3GXAAI6ZJNQVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>originalFile/span>span classp>:/span>span classw> /span>span classs2>aviato.png/span>span classp>,/span>span classw> /span>span classs2>fileUrl/span>span classp>:/span>span classw> /span>span classs2>https://s3-us-west-2.amazonaws.com/blockchyp-prod-media/media/4QZ2I4QYIMI6TPHVAJBKYEIAA4/MR4VSDPP6SHJFZQXEYAYJJ5KCI/MR4VSDPP6SHJFZQXEYAYJJ5KCI.png/span>span classp>,/span>span classw> /span>span classs2>thumbnailUrl/span>span classp>:/span>span classw> /span>span classs2>https://s3-us-west-2.amazonaws.com/blockchyp-prod-media/media/4QZ2I4QYIMI6TPHVAJBKYEIAA4/MR4VSDPP6SHJFZQXEYAYJJ5KCI/MR4VSDPP6SHJFZQXEYAYJJ5KCI_t.png/span>span classp>,/span>span classw> /span>span classs2>video/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant, Partner, & Organization/li>li>strong>Required Role:/strong> Media Management/li>/ul>p>This API returns the entire media library associated with the API Credentials (Merchant, Partner, or Organization). The media library results will include the ID usedto reference a media asset in slide shows and branding assets along with the full file url and thumbnail./p>h2 idupload-media>Upload Media/h2>blockquote>p>Upload Media Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>upload-media/span> -filespan classo>/span>span classs2>aviato.png/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>upload-media/span> -filespan classo>/span>span classs2>aviato.png/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classs>os/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>uploadMediaExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>UploadMetadata/span>span classp>{/span>span classx> /span>span classn>FileName/span>span classo>:/span>span classx> /span>span classs>aviato.png/span>span classp>,/span>span classx> /span>span classn>FileSize/span>span classo>:/span>span classx> /span>span classm>18843/span>span classp>,/span>span classx> /span>span classn>UploadID/span>span classo>:/span>span classx> /span>span classs><RANDOM ID>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>file/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>os/span>span classo>./span>span classn>Open/span>span classp>(/span>span classs>filename.png/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>UploadMedia/span>span classp>(/span>span classn>request/span>span classp>,/span>span classx> /span>span classn>file/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>UploadMetadata/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>UploadMetadata/span>span classp>{/span> span classn>FileName/span> span classp>/span> span classs>aviato.png/span>span classp>,/span> span classn>FileSize/span> span classp>/span> span classm>18843/span>span classp>,/span> span classn>UploadId/span> span classp>/span> span classs><RANDOM ID>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>FileStream/span> span classn>inStream/span> span classp>/span> span classk>new/span> span classnf>FileStream/span>span classp>(/span>span classs>filename.png/span>span classp>,/span> span classn>FileMode/span>span classp>./span>span classn>Open/span>span classp>,/span> span classn>FileAccess/span>span classp>./span>span classn>Read/span>span classp>);/span>span classn>MediaMetadata/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>UploadMediaAsync/span>span classp>(/span>span classn>request/span>span classp>,/span> span classn>inStream/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.io.File/span>span classo>;/span>span classkn>import/span> span classnn>java.io.InputStream/span>span classo>;/span>span classkn>import/span> span classnn>java.io.FileInputStream/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.UploadMetadata/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.MediaMetadata/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>UploadMediaExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>UploadMetadata/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>UploadMetadata/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setFileName/span>span classo>(/span>span classs>aviato.png/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setFileSize/span>span classo>(/span>span classmi>18843/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setUploadId/span>span classo>(/span>span classs><RANDOM ID>/span>span classo>);/span> span classc1>// Send the request/span> span classn>InputStream/span> span classn>inStream/span> span classo>/span> span classk>new/span> span classn>FileInputStream/span>span classo>(/span>span classk>new/span> span classn>File/span>span classo>(/span>span classs>aviato.png/span>span classo>));/span> span classn>MediaMetadata/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>uploadMedia/span>span classo>(/span>span classn>request/span>span classo>,/span> span classn>inStream/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>fileName/span> span classo>>/span> span classs1>aviato.png/span>span classp>,/span> span classs1>fileSize/span> span classo>>/span> span classmi>18843/span>span classp>,/span> span classs1>uploadId/span> span classo>>/span> span classs1><RANDOM ID>/span>span classp>,/span>span classp>;/span>span classnv>$file/span> span classo>/span> span classnb>file_get_contents/span>span classp>(/span>span classs1>aviato.png/span>span classp>);/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>uploadMedia/span>span classp>(/span>span classnv>$request/span>span classp>,/span> span classnv>$file/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>fileName: /span>span classs1>aviato.png/span>span classp>,/span> span classss>fileSize: /span>span classmi>18843/span>span classp>,/span> span classss>uploadId: /span>span classs1><RANDOM ID>/span>span classp>}/span>span classn>file/span> span classo>/span> span classno>File/span>span classp>./span>span classnf>open/span>span classp>(/span>span classs2>aviato.png/span>span classp>)/span>span classn>content/span> span classo>/span> span classn>file/span>span classp>./span>span classnf>read/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>uploadMedia/span>span classp>(/span>span classn>request/span>span classp>,/span> span classn>content/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>fileName/span>span classp>:/span> span classs>aviato.png/span>span classp>,/span> span classs>fileSize/span>span classp>:/span> span classmi>18843/span>span classp>,/span> span classs>uploadId/span>span classp>:/span> span classs><RANDOM ID>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>f/span> span classo>/span> span classnb>open/span>span classp>(/span>span classs>aviato.png/span>span classp>,/span> span classs>rb/span>span classp>)/span>span classn>content/span> span classo>/span> span classn>f/span>span classo>./span>span classn>read/span>span classp>()/span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>upload_media/span>span classp>(/span>span classn>request/span>span classp>,/span> span classn>content/span>span classp>)/span>span classn>f/span>span classo>./span>span classn>close/span>span classp>()/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>var/span> span classnx>fs/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>fs/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>let/span> span classnx>content/span> span classo>/span> span classnx>fs/span>span classp>./span>span classnx>readFileSync/span>span classp>(/span>span classs1>aviato.png/span>span classp>);/span>span classnx>client/span>span classp>./span>span classnx>uploadMedia/span>span classp>({/span> span classna>fileName/span>span classp>:/span> span classs1>aviato.png/span>span classp>,/span> span classna>fileSize/span>span classp>:/span> span classmi>18843/span>span classp>,/span> span classna>uploadId/span>span classp>:/span> span classs1><RANDOM ID>/span>span classp>,/span>span classp>},/span> span classnx>content/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classk>import/span> span classnx>fs/span> span classk>from/span> span classs1>fs/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>UploadMetadata/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>fileName/span> span classo>/span> span classs1>aviato.png/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>fileSize/span> span classo>/span> span classmi>18843/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>uploadId/span> span classo>/span> span classs1><RANDOM ID>/span>span classp>;/span>span classkd>const/span> span classnx>content/span> span classo>/span> span classnx>fs/span>span classp>./span>span classnx>readFileSync/span>span classp>(/span>span classs1>aviato.png/span>span classp>);/span>span classnx>client/span>span classp>./span>span classnx>uploadMedia/span>span classp>(/span>span classnx>request/span>span classp>,/span> span classnx>content/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>MediaMetadata/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>fileName/span>span classp>/span> span classo>/span> span classs>aviato.png/span> span classn>request/span>span classp>/span>span classs>fileSize/span>span classp>/span> span classo>/span> span classmi>18843/span> span classn>request/span>span classp>/span>span classs>uploadId/span>span classp>/span> span classo>/span> span classs><RANDOM ID>/span> span classn>NSData/span> span classo>*/span>span classn>content/span> span classo>/span> span classp>/span>span classn>NSData/span> span classnf>dataWithContentsOfFile/span>span classp>:/span>span classs>@aviato.png/span>span classp>;/span> span classp>/span>span classn>client/span> span classnf>uploadMediaWithRequest/span>span classp>:/span>span classn>request/span> span classnf>content/span>span classp>:/span>span classn>content/span> span classn>handler/span>span classo>:^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>fileName/span>span classp>/span> span classo>/span> span classs>aviato.png/span> span classn>request/span>span classp>/span>span classs>fileSize/span>span classp>/span> span classo>/span> span classmi>18843/span> span classn>request/span>span classp>/span>span classs>uploadId/span>span classp>/span> span classo>/span> span classs><RANDOM ID>/span> span classk>var/span> span classnv>content/span> span classo>/span> span classkt>Data/span>span classp>(/span>span classnv>contentsOfFile/span>span classp>:/span> span classs>aviato.png/span>span classp>)/span> span classn>client/span>span classo>./span>span classnf>uploadMedia/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>content/span>span classp>:/span> span classn>content/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>fs/span>span classp>::/span>span classn>File/span>span classp>;/span>span classk>fn/span> span classnf>upload_media_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>UploadMetadata/span>span classp>{/span> span classn>file_name/span>span classp>:/span> span classs>aviato.png/span>span classnf>.to_string/span>span classp>(),/span> span classn>file_size/span>span classp>:/span> span classmi>18843/span>span classp>,/span> span classn>upload_id/span>span classp>:/span> span classs><RANDOM ID>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classk>mut/span> span classn>file/span> span classo>/span> span classnn>File/span>span classp>::/span>span classnf>open/span>span classp>(/span>span classs>aviato.png/span>span classp>)/span>span classo>?/span>span classp>;/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.upload_media/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>,/span> span classo>&/span>span classk>mut/span> span classn>file/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>upload_media_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>DEQZQ3GXAAI6ZJNQVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>originalFile/span>span classp>:/span>span classw> /span>span classs2>aviato.png/span>span classp>,/span>span classw> /span>span classs2>fileUrl/span>span classp>:/span>span classw> /span>span classs2>https://s3-us-west-2.amazonaws.com/blockchyp-prod-media/media/4QZ2I4QYIMI6TPHVAJBKYEIAA4/MR4VSDPP6SHJFZQXEYAYJJ5KCI/MR4VSDPP6SHJFZQXEYAYJJ5KCI.png/span>span classp>,/span>span classw> /span>span classs2>thumbnailUrl/span>span classp>:/span>span classw> /span>span classs2>https://s3-us-west-2.amazonaws.com/blockchyp-prod-media/media/4QZ2I4QYIMI6TPHVAJBKYEIAA4/MR4VSDPP6SHJFZQXEYAYJJ5KCI/MR4VSDPP6SHJFZQXEYAYJJ5KCI_t.png/span>span classp>,/span>span classw> /span>span classs2>video/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant, Partner, & Organization/li>li>strong>Required Role:/strong> Media Management/li>/ul>p>This API supports media library uploads. The operation of this API works slightly differently depending on the SDK platform. In all cases, the intent is to allow the file's binary to be passed into the SDK using the lowest level I/O primitive possible in order to support situations where developers aren't workingwith literal files. It might be (and usually is) more convenient to work with buffers, raw bytes, or streams./p>p>For example, the Go implementation accepts an code>io.Reader/code> and the Java implementation accepts acode>java.io.InputStream/code>. The CLI does accept a literal File URL via the code>-file/code> command line parameter./p>p>The following file formats are accepted as valid uploads:/p>ul>li>.png/li>li>.jpg/li>li>.jpeg/li>li>.gif/li>li>.mov/li>li>.mpg/li>li>.mp4/li>li>.mpeg/li>/ul>p>The UploadMetadata object allows developers to pass additional metadata about the upload includingcode>fileName/code>, code>fileSize/code>, and code>uploadId/code>./p>p>None of these values are required, but providing them can unlock some additional functionality relating to media uploads. code>fileName/code> will be used to record the original file name in the media library. code>fileSize/code> and code>uploadId/code> are used to support upload status tracking, which is especially useful for large video fileuploads. /p>p>The code>fileSize/code> should be the file's full size in bytes. /p>p>The code>uploadId/code> value can be any random string. This is the value you'll use to check the status of an uploadvia the Upload Status API. This API will return information needed to drive progress feedback on uploads and return video transcoding information./p>aside classwarning>b>Note for IOS Developers:/b> If you plan on supporting PNG file uploads in your IOS application, make sure your project build settingsturn PNG compression off. XCode converts PNG files to the proprietary Apple CgBI format by default and BlockChyp does not currentlysupport the CgBI file format./aside>h2 idupload-status>Upload Status/h2>blockquote>p>Upload Status Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>upload-status/span> -uploadIdspan classo>/span>span classs2><UPLOAD ID>/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>upload-status/span> -uploadIdspan classo>/span>span classs2><UPLOAD ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>uploadStatusExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>UploadStatusRequest/span>span classp>{/span>span classx> /span>span classn>UploadID/span>span classo>:/span>span classx> /span>span classs><UPLOAD ID>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>UploadStatus/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>UploadStatusRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>UploadStatusRequest/span>span classp>{/span> span classn>UploadId/span> span classp>/span> span classs><UPLOAD ID>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>UploadStatus/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>UploadStatusAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.UploadStatusRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.UploadStatus/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>UploadStatusExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>UploadStatusRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>UploadStatusRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setUploadId/span>span classo>(/span>span classs><UPLOAD ID>/span>span classo>);/span> span classc1>// Send the request/span> span classn>UploadStatus/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>uploadStatus/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>uploadId/span> span classo>>/span> span classs1><UPLOAD ID>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>uploadStatus/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>uploadId: /span>span classs1><UPLOAD ID>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>uploadStatus/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>uploadId/span>span classp>:/span> span classs><UPLOAD ID>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>upload_status/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>uploadStatus/span>span classp>({/span> span classna>uploadId/span>span classp>:/span> span classs1><UPLOAD ID>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>UploadStatusRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>uploadId/span> span classo>/span> span classs1><UPLOAD ID>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>uploadStatus/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>UploadStatus/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>uploadId/span>span classp>/span> span classo>/span> span classs><UPLOAD ID>/span> span classp>/span>span classn>client/span> span classnf>uploadStatusWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>uploadId/span>span classp>/span> span classo>/span> span classs><UPLOAD ID>/span> span classn>client/span>span classo>./span>span classnf>uploadStatus/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>upload_status_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>UploadStatusRequest/span>span classp>{/span> span classn>upload_id/span>span classp>:/span> span classs><UPLOAD ID>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.upload_status/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>upload_status_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>907b56aa-dba6-11ec-be29-acde48001122/span>span classp>,/span>span classw> /span>span classs2>mediaId/span>span classp>:/span>span classw> /span>span classs2>VMDFUFG3UII6ZNZEVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>fileSize/span>span classp>:/span>span classw> /span>span classmi>56529/span>span classp>,/span>span classw> /span>span classs2>uploadedAmount/span>span classp>:/span>span classw> /span>span classmi>56529/span>span classp>,/span>span classw> /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>Done/span>span classp>,/span>span classw> /span>span classs2>complete/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>processing/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>percentage/span>span classp>:/span>span classw> /span>span classmi>100/span>span classp>,/span>span classw> /span>span classs2>thumbnailLocation/span>span classp>:/span>span classw> /span>span classs2>https://s3-us-west-2.amazonaws.com/blockchyp-prod-media/media/WY2ZBQWRFEI6ZE6FVTPEQAAREI/7A2G33EJCIK2JPQA4EBQI3EDSI/7A2G33EJCIK2JPQA4EBQI3EDSI_t.png/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant, Partner, & Organization/li>li>strong>Required Role:/strong> Media Management/li>/ul>p>This API returns status and progress information about in progress or recently completed uploads./p>p>Before calling this API, developers must first start a file upload with code>fileSize/code> and code>uploadId/code> parameters./p>p>The data structure returned will include the file size, number of bytes uploaded, a narrative statusand flags indicating whether or not the upload is complete or post upload processing is in progress.br>If the upload is completed, the ID assigned to the media asset and a link to the thumbnail image will also be returned./p>h2 idget-media-asset>Get Media Asset/h2>blockquote>p>Get Media Asset Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>media-asset/span> -mediaIdspan classo>/span>span classs2><MEDIA ASSET ID>/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>media-asset/span> -mediaIdspan classo>/span>span classs2><MEDIA ASSET ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>mediaAssetExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>MediaRequest/span>span classp>{/span>span classx> /span>span classn>MediaID/span>span classo>:/span>span classx> /span>span classs><MEDIA ASSET ID>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>MediaAsset/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>MediaRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>MediaRequest/span>span classp>{/span> span classn>MediaId/span> span classp>/span> span classs><MEDIA ASSET ID>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>MediaMetadata/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>MediaAssetAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.MediaRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.MediaMetadata/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>MediaAssetExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>MediaRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>MediaRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setMediaId/span>span classo>(/span>span classs><MEDIA ASSET ID>/span>span classo>);/span> span classc1>// Send the request/span> span classn>MediaMetadata/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>mediaAsset/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>mediaId/span> span classo>>/span> span classs1><MEDIA ASSET ID>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>mediaAsset/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>mediaId: /span>span classs1><MEDIA ASSET ID>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>mediaAsset/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>mediaId/span>span classp>:/span> span classs><MEDIA ASSET ID>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>media_asset/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>mediaAsset/span>span classp>({/span> span classna>mediaId/span>span classp>:/span> span classs1><MEDIA ASSET ID>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>MediaRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>mediaId/span> span classo>/span> span classs1><MEDIA ASSET ID>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>mediaAsset/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>MediaMetadata/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>mediaId/span>span classp>/span> span classo>/span> span classs><MEDIA ASSET ID>/span> span classp>/span>span classn>client/span> span classnf>mediaAssetWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>mediaId/span>span classp>/span> span classo>/span> span classs><MEDIA ASSET ID>/span> span classn>client/span>span classo>./span>span classnf>mediaAsset/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>media_asset_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>MediaRequest/span>span classp>{/span> span classn>media_id/span>span classp>:/span> span classs><MEDIA ASSET ID>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.media_asset/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>media_asset_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>6Z2LQRW3VUI6ZMI5VTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>originalFile/span>span classp>:/span>span classw> /span>span classs2>aviato.png/span>span classp>,/span>span classw> /span>span classs2>fileUrl/span>span classp>:/span>span classw> /span>span classs2>https://s3-us-west-2.amazonaws.com/blockchyp-prod-media/media/WY2ZBQWRFEI6ZE6FVTPEQAAREI/3D623QCUI664P5K7TTXJ5SSMDI/3D623QCUI664P5K7TTXJ5SSMDI.png/span>span classp>,/span>span classw> /span>span classs2>thumbnailUrl/span>span classp>:/span>span classw> /span>span classs2>https://s3-us-west-2.amazonaws.com/blockchyp-prod-media/media/WY2ZBQWRFEI6ZE6FVTPEQAAREI/HMYKFCIJUOSDEAU4HQD6ZOKQ24/HMYKFCIJUOSDEAU4HQD6ZOKQ24_t.png/span>span classp>,/span>span classw> /span>span classs2>video/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant, Partner, & Organization/li>li>strong>Required Role:/strong> Media Management/li>/ul>p>This API returns a detailed media asset. The data returned includes the exact same media information returnedby the full media library endpoint, including fully qualified URLs pointing to the original media fileand the thumbnail./p>h2 iddelete-media-asset>Delete Media Asset/h2>blockquote>p>Delete Media Asset Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>delete-media/span> -mediaIdspan classo>/span>span classs2><MEDIA ASSET ID>/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>delete-media/span> -mediaIdspan classo>/span>span classs2><MEDIA ASSET ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>deleteMediaAssetExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>MediaRequest/span>span classp>{/span>span classx> /span>span classn>MediaID/span>span classo>:/span>span classx> /span>span classs><MEDIA ASSET ID>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>DeleteMediaAsset/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>MediaRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>MediaRequest/span>span classp>{/span> span classn>MediaId/span> span classp>/span> span classs><MEDIA ASSET ID>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>Acknowledgement/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>DeleteMediaAssetAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.MediaRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.Acknowledgement/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>DeleteMediaAssetExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>MediaRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>MediaRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setMediaId/span>span classo>(/span>span classs><MEDIA ASSET ID>/span>span classo>);/span> span classc1>// Send the request/span> span classn>Acknowledgement/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>deleteMediaAsset/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>mediaId/span> span classo>>/span> span classs1><MEDIA ASSET ID>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>deleteMediaAsset/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>mediaId: /span>span classs1><MEDIA ASSET ID>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>deleteMediaAsset/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>mediaId/span>span classp>:/span> span classs><MEDIA ASSET ID>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>delete_media_asset/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>deleteMediaAsset/span>span classp>({/span> span classna>mediaId/span>span classp>:/span> span classs1><MEDIA ASSET ID>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>MediaRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>mediaId/span> span classo>/span> span classs1><MEDIA ASSET ID>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>deleteMediaAsset/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>Acknowledgement/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>mediaId/span>span classp>/span> span classo>/span> span classs><MEDIA ASSET ID>/span> span classp>/span>span classn>client/span> span classnf>deleteMediaAssetWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>mediaId/span>span classp>/span> span classo>/span> span classs><MEDIA ASSET ID>/span> span classn>client/span>span classo>./span>span classnf>deleteMediaAsset/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>delete_media_asset_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>MediaRequest/span>span classp>{/span> span classn>media_id/span>span classp>:/span> span classs><MEDIA ASSET ID>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.delete_media_asset/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>delete_media_asset_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant, Partner, & Organization/li>li>strong>Required Role:/strong> Media Management/li>/ul>p>This API deletes a media asset. Note that a media asset cannot be deleted if it is in use in a slide show or in the terminal branding stack./p>h2 idlist-slide-shows>List Slide Shows/h2>blockquote>p>List Slide Shows Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>slide-shows/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>slide-shows/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>slideShowsExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>SlideShowRequest/span>span classp>{}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>SlideShows/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>SlideShowRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>SlideShowRequest/span>span classp>{/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>SlideShowResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>SlideShowsAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.SlideShowRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.SlideShowResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>SlideShowsExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>SlideShowRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>SlideShowRequest/span>span classo>();/span> span classc1>// Send the request/span> span classn>SlideShowResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>slideShows/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>slideShows/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>slideShows/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>slide_shows/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>slideShows/span>span classp>({/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>SlideShowRequest/span>span classp>();/span>span classnx>client/span>span classp>./span>span classnx>slideShows/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>SlideShowResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classp>/span>span classn>client/span> span classnf>slideShowsWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>client/span>span classo>./span>span classnf>slideShows/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>slide_shows_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>SlideShowRequest/span>span classp>{/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.slide_shows/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>slide_shows_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>maxResults/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>startIndex/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>resultCount/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>results/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>timeout/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>2XIVCRHBFII6ZGMRAJBKYEIAAM/span>span classp>,/span>span classw> /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>Test Slide Show/span>span classp>,/span>span classw> /span>span classs2>delay/span>span classp>:/span>span classw> /span>span classmi>5/span>span classp>,/span>span classw> /span>span classs2>slides/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant, Partner, & Organization/li>li>strong>Required Role:/strong> Media Management/li>/ul>p>This API returns all slide shows. /p>p>Note that slide level data is not returned with this API. Use the Get Slide Show API to get slide level detail./p>h2 idget-slide-show>Get Slide Show/h2>blockquote>p>Get Slide Show Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>slide-show/span> -slideShowIdspan classo>/span>span classs2><SLIDE SHOW ID>/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>slide-show/span> -slideShowIdspan classo>/span>span classs2><SLIDE SHOW ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>slideShowExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>SlideShowRequest/span>span classp>{/span>span classx> /span>span classn>SlideShowID/span>span classo>:/span>span classx> /span>span classs><SLIDE SHOW ID>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>SlideShow/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>SlideShowRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>SlideShowRequest/span>span classp>{/span> span classn>SlideShowId/span> span classp>/span> span classs><SLIDE SHOW ID>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>SlideShow/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>SlideShowAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.SlideShowRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.SlideShow/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>SlideShowExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>SlideShowRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>SlideShowRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setSlideShowId/span>span classo>(/span>span classs><SLIDE SHOW ID>/span>span classo>);/span> span classc1>// Send the request/span> span classn>SlideShow/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>slideShow/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>slideShowId/span> span classo>>/span> span classs1><SLIDE SHOW ID>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>slideShow/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>slideShowId: /span>span classs1><SLIDE SHOW ID>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>slideShow/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>slideShowId/span>span classp>:/span> span classs><SLIDE SHOW ID>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>slide_show/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>slideShow/span>span classp>({/span> span classna>slideShowId/span>span classp>:/span> span classs1><SLIDE SHOW ID>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>SlideShowRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>slideShowId/span> span classo>/span> span classs1><SLIDE SHOW ID>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>slideShow/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>SlideShow/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>slideShowId/span>span classp>/span> span classo>/span> span classs><SLIDE SHOW ID>/span> span classp>/span>span classn>client/span> span classnf>slideShowWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>slideShowId/span>span classp>/span> span classo>/span> span classs><SLIDE SHOW ID>/span> span classn>client/span>span classo>./span>span classnf>slideShow/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>slide_show_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>SlideShowRequest/span>span classp>{/span> span classn>slide_show_id/span>span classp>:/span> span classs><SLIDE SHOW ID>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.slide_show/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>slide_show_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>YLUES3G4LMI6ZNOWVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>Test Slide Show/span>span classp>,/span>span classw> /span>span classs2>delay/span>span classp>:/span>span classw> /span>span classmi>5/span>span classp>,/span>span classw> /span>span classs2>slides/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>mediaId/span>span classp>:/span>span classw> /span>span classs2>YLUESOW4LMI6ZNOWVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>ordinal/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>thumbnailUrl/span>span classp>:/span>span classw> /span>span classs2>https://s3-us-west-2.amazonaws.com/blockchyp-prod-media/media/WY2ZBQWRFEI6ZE6FVTPEQAAREI/QSLIXT2UNV77JGEGSNZDPAJYQU/QSLIXT2UNV77JGEGSNZDPAJYQU_t.png/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant, Partner, & Organization/li>li>strong>Required Role:/strong> Media Management/li>/ul>p>This API returns a single slide show. Slide level detail is returned with the fully qualified thumbnail URLfor each slide./p>p>code>slideShowId/code> is the only required parameter./p>h2 idupdate-slide-show>Update Slide Show/h2>blockquote>p>Update Slide Show Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>update-slide-show/span> -mediaIdspan classo>/span>span classs2><LIST OF MEDIA IDs>/span> -namespan classo>/span>span classs2>Test Slide Show/span> -delayspan classo>/span>5Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>update-slide-show/span> -mediaIdspan classo>/span>span classs2><LIST OF MEDIA IDs>/span> -namespan classo>/span>span classs2>Test Slide Show/span> -delayspan classo>/span>5/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>updateSlideShowExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>SlideShow/span>span classp>{/span>span classx> /span>span classn>Name/span>span classo>:/span>span classx> /span>span classs>Test Slide Show/span>span classp>,/span>span classx> /span>span classn>Delay/span>span classo>:/span>span classx> /span>span classm>5/span>span classp>,/span>span classx> /span>span classn>Slides/span>span classo>:/span>span classx> /span>span classp>/span>span classo>*/span>span classn>blockchyp/span>span classo>./span>span classn>Slide/span>span classp>{/span>span classx> /span>span classo>&/span>span classn>blockchyp/span>span classo>./span>span classn>Slide/span>span classp>{/span>span classx> /span>span classn>MediaID/span>span classo>:/span>span classx> /span>span classs><MEDIA ID>/span>span classp>,/span>span classx> /span>span classp>},/span>span classx> /span>span classp>},/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>UpdateSlideShow/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>SlideShow/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>SlideShow/span>span classp>{/span> span classn>Name/span> span classp>/span> span classs>Test Slide Show/span>span classp>,/span> span classn>Delay/span> span classp>/span> span classm>5/span>span classp>,/span> span classn>Slides/span> span classp>/span> span classk>new/span> span classn>List/span>span classp>span classn>Slide/span>span classp>>/span> span classp>{/span> span classk>new/span> span classn>Slide/span> span classp>{/span> span classn>MediaId/span> span classp>/span> span classs><MEDIA ID>/span>span classp>,/span> span classp>}/span> span classp>},/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>SlideShow/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>UpdateSlideShowAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.SlideShow/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.SlideShow/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.Slide/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>UpdateSlideShowExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>SlideShow/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>SlideShow/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setName/span>span classo>(/span>span classs>Test Slide Show/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setDelay/span>span classo>(/span>span classmi>5/span>span classo>);/span> span classn>Collection/span> span classn>slides/span> span classo>/span> span classk>new/span> span classn>ArrayList/span>span classo>();/span> span classn>Slide/span> span classn>slides0/span> span classo>/span> span classk>new/span> span classn>Slide/span>span classo>();/span> span classn>slides0/span>span classo>./span>span classna>setMediaId/span>span classo>(/span>span classs><MEDIA ID>/span>span classo>);/span> span classn>slides/span>span classo>./span>span classna>add/span>span classo>(/span>span classn>slides0/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setSlides/span>span classo>(/span>span classn>slides/span>span classo>);/span> span classc1>// Send the request/span> span classn>SlideShow/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>updateSlideShow/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>name/span> span classo>>/span> span classs1>Test Slide Show/span>span classp>,/span> span classs1>delay/span> span classo>>/span> span classmi>5/span>span classp>,/span> span classs1>slides/span> span classo>>/span> span classp>/span> span classp>/span> span classs1>mediaId/span> span classo>>/span> span classs1><MEDIA ID>/span>span classp>,/span> span classp>,/span> span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>updateSlideShow/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>name: /span>span classs1>Test Slide Show/span>span classp>,/span> span classss>delay: /span>span classmi>5/span>span classp>,/span> span classss>slides: /span>span classp>/span> span classp>{/span> span classss>mediaId: /span>span classs1><MEDIA ID>/span> span classp>}/span> span classp>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>updateSlideShow/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>name/span>span classp>:/span> span classs>Test Slide Show/span>span classp>,/span> span classs>delay/span>span classp>:/span> span classmi>5/span>span classp>,/span> span classs>slides/span>span classp>:/span> span classp>/span> span classp>{/span> span classs>mediaId/span>span classp>:/span> span classs><MEDIA ID>/span>span classp>,/span> span classp>},/span> span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>update_slide_show/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>updateSlideShow/span>span classp>({/span> span classna>name/span>span classp>:/span> span classs1>Test Slide Show/span>span classp>,/span> span classna>delay/span>span classp>:/span> span classmi>5/span>span classp>,/span> span classna>slides/span>span classp>:/span> span classp>/span> span classp>{/span> span classna>mediaId/span>span classp>:/span> span classs1><MEDIA ID>/span>span classp>,/span> span classp>},/span> span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>SlideShow/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>name/span> span classo>/span> span classs1>Test Slide Show/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>delay/span> span classo>/span> span classmi>5/span>span classp>;/span>span classkd>const/span> span classnx>slides/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>Slide/span>span classp>();/span>span classnx>slides/span>span classp>./span>span classnx>mediaId/span> span classo>/span> span classs1><MEDIA ID>/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>slides/span> span classo>/span> span classp>/span>span classnx>slides/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>updateSlideShow/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>SlideShow/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>name/span>span classp>/span> span classo>/span> span classs>Test Slide Show/span> span classn>request/span>span classp>/span>span classs>delay/span>span classp>/span> span classo>/span> span classmi>5/span> span classn>var/span> span classn>slides/span> span classo>/span> span classp>/span>span classnf>Any/span>span classp>();/span> span classn>var/span> span classn>slides1/span>span classo>:/span> span classp>/span>span classnf>String/span>span classp>:/span>span classn>Any/span>span classp>/span> span classo>/span> span classp>/span>span classo>:/span>span classp>/span> span classn>slides1/span>span classp>/span>span classs>mediaId/span>span classp>/span> span classo>/span> span classs><MEDIA ID>/span> span classn>slides/span>span classp>./span>span classn>append/span>span classp>(/span>span classn>slides1/span>span classp>)/span> span classn>request/span>span classp>/span>span classs>slides/span>span classp>/span> span classo>/span> span classn>slides/span> span classp>/span>span classn>client/span> span classnf>updateSlideShowWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>name/span>span classp>/span> span classo>/span> span classs>Test Slide Show/span> span classn>request/span>span classp>/span>span classs>delay/span>span classp>/span> span classo>/span> span classmi>5/span> span classk>var/span> span classnv>slides/span> span classo>/span> span classp>/span>span classkt>Any/span>span classp>();/span> span classk>var/span> span classnv>slides1/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>slides1/span>span classp>/span>span classs>mediaId/span>span classp>/span> span classo>/span> span classs><MEDIA ID>/span> span classn>slides/span>span classo>./span>span classnf>append/span>span classp>(/span>span classn>slides1/span>span classp>)/span> span classn>request/span>span classp>/span>span classs>slides/span>span classp>/span> span classo>/span> span classn>slides/span> span classn>client/span>span classo>./span>span classnf>updateSlideShow/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>update_slide_show_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>SlideShow/span>span classp>{/span> span classn>name/span>span classp>:/span> span classs>Test Slide Show/span>span classnf>.to_string/span>span classp>(),/span> span classn>delay/span>span classp>:/span> span classmi>5/span>span classp>,/span> span classn>slides/span>span classp>:/span> span classnf>Some/span>span classp>(/span>span classnd>vec!/span>span classp>/span> span classnn>blockchyp/span>span classp>::/span>span classn>Slide/span>span classp>{/span> span classn>media_id/span>span classp>:/span> span classs><MEDIA ID>/span>span classnf>.to_string/span>span classp>(),/span> .span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>},/span> span classp>),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.update_slide_show/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>update_slide_show_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>YLUES3G4LMI6ZNOWVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>name/span>span classp>:/span>span classw> /span>span classs2>Test Slide Show/span>span classp>,/span>span classw> /span>span classs2>delay/span>span classp>:/span>span classw> /span>span classmi>5/span>span classp>,/span>span classw> /span>span classs2>slides/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>mediaId/span>span classp>:/span>span classw> /span>span classs2>YLUESOW4LMI6ZNOWVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>ordinal/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>thumbnailUrl/span>span classp>:/span>span classw> /span>span classs2>https://s3-us-west-2.amazonaws.com/blockchyp-prod-media/media/WY2ZBQWRFEI6ZE6FVTPEQAAREI/QSLIXT2UNV77JGEGSNZDPAJYQU/QSLIXT2UNV77JGEGSNZDPAJYQU_t.png/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant, Partner, & Organization/li>li>strong>Required Role:/strong> Media Management/li>/ul>p>This API updates or creates a slide show. code>name/code>, code>delay/code> and code>slides/code> are required./p>p>The slides property is an array of slides. The Slide data structure has ordinal and thumbnail URL fields, but these are not required when updating or creating a slide show. Only the code>mediaId/code> field is requiredwhen updating or creating a slide show./p>p>When using the CLI, slides can be specified by sending a comma-separated list of media ids via the code>-mediaId/code>parameter./p>h2 iddelete-slide-show>Delete Slide Show/h2>blockquote>p>Delete Slide Show Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>delete-slide-show/span> -slideShowIdspan classo>/span>span classs2><SLIDE SHOW ID>/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>delete-slide-show/span> -slideShowIdspan classo>/span>span classs2><SLIDE SHOW ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>deleteSlideShowExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>SlideShowRequest/span>span classp>{/span>span classx> /span>span classn>SlideShowID/span>span classo>:/span>span classx> /span>span classs><SLIDE SHOW ID>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>DeleteSlideShow/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>SlideShowRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>SlideShowRequest/span>span classp>{/span> span classn>SlideShowId/span> span classp>/span> span classs><SLIDE SHOW ID>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>Acknowledgement/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>DeleteSlideShowAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.SlideShowRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.Acknowledgement/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>DeleteSlideShowExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>SlideShowRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>SlideShowRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setSlideShowId/span>span classo>(/span>span classs><SLIDE SHOW ID>/span>span classo>);/span> span classc1>// Send the request/span> span classn>Acknowledgement/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>deleteSlideShow/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>slideShowId/span> span classo>>/span> span classs1><SLIDE SHOW ID>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>deleteSlideShow/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>slideShowId: /span>span classs1><SLIDE SHOW ID>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>deleteSlideShow/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>slideShowId/span>span classp>:/span> span classs><SLIDE SHOW ID>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>delete_slide_show/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>deleteSlideShow/span>span classp>({/span> span classna>slideShowId/span>span classp>:/span> span classs1><SLIDE SHOW ID>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>SlideShowRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>slideShowId/span> span classo>/span> span classs1><SLIDE SHOW ID>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>deleteSlideShow/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>Acknowledgement/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>slideShowId/span>span classp>/span> span classo>/span> span classs><SLIDE SHOW ID>/span> span classp>/span>span classn>client/span> span classnf>deleteSlideShowWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>slideShowId/span>span classp>/span> span classo>/span> span classs><SLIDE SHOW ID>/span> span classn>client/span>span classo>./span>span classnf>deleteSlideShow/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>delete_slide_show_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>SlideShowRequest/span>span classp>{/span> span classn>slide_show_id/span>span classp>:/span> span classs><SLIDE SHOW ID>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.delete_slide_show/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>delete_slide_show_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant, Partner, & Organization/li>li>strong>Required Role:/strong> Media Management/li>/ul>p>This API deletes a slide show code>slideShowId/code> is the only required parameter./p>h2 idterminal-branding>Terminal Branding/h2>blockquote>p>Terminal Branding Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>terminal-branding/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>terminal-branding/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>terminalBrandingExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>BrandingAssetRequest/span>span classp>{}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>TerminalBranding/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>BrandingAssetRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>BrandingAssetRequest/span>span classp>{/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>BrandingAssetResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>TerminalBrandingAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.BrandingAssetRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.BrandingAssetResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>TerminalBrandingExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>BrandingAssetRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>BrandingAssetRequest/span>span classo>();/span> span classc1>// Send the request/span> span classn>BrandingAssetResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>terminalBranding/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>terminalBranding/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>terminalBranding/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>terminal_branding/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>terminalBranding/span>span classp>({/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>BrandingAssetRequest/span>span classp>();/span>span classnx>client/span>span classp>./span>span classnx>terminalBranding/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>BrandingAssetResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classp>/span>span classn>client/span> span classnf>terminalBrandingWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>client/span>span classo>./span>span classnf>terminalBranding/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>terminal_branding_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>BrandingAssetRequest/span>span classp>{/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.terminal_branding/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>terminal_branding_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>ownerId/span>span classp>:/span>span classw> /span>span classs2>WY2ZBQWRFEI6ZE6FVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>ownerType/span>span classp>:/span>span classw> /span>span classs2>merchant/span>span classp>,/span>span classw> /span>span classs2>ownerName/span>span classp>:/span>span classw> /span>span classs2>Test Merchant/span>span classp>,/span>span classw> /span>span classs2>levelName/span>span classp>:/span>span classw> /span>span classs2>Merchant/span>span classp>,/span>span classw> /span>span classs2>narrativeTime/span>span classp>:/span>span classw> /span>span classs2>Visible Now/span>span classp>,/span>span classw> /span>span classs2>activeAsset/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>MPFZTVGXYQI6ZCOVVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>ownerId/span>span classp>:/span>span classw> /span>span classs2>WY2ZBQWRFEI6ZE6FVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>terminalId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>terminalGroupId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>merchantId/span>span classp>:/span>span classw> /span>span classs2>WY2ZBQWRFEI6ZE6FVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>organizationId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>partnerId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>slideShowId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>mediaId/span>span classp>:/span>span classw> /span>span classs2>QGPDOJGXQ4I6ZBAAVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>padded/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>startDate/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>endDate/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>daysOfWeek/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classs2>startTime/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>endTime/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>ordinal/span>span classp>:/span>span classw> /span>span classmi>5/span>span classp>,/span>span classw> /span>span classs2>enabled/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>preview/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>userId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>userName/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>thumbnail/span>span classp>:/span>span classw> /span>span classs2>https://s3-us-west-2.amazonaws.com/blockchyp-prod-media/media/WY2ZBQWRFEI6ZE6FVTPEQAAREI/UEX46TRTVGPM4STIXH3RLBVOSA/UEX46TRTVGPM4STIXH3RLBVOSA_t.png/span>span classp>,/span>span classw> /span>span classs2>lastModified/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>notes/span>span classp>:/span>span classw> /span>span classs2>API CREATED/span>span classp>,/span>span classw> /span>span classs2>editable/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>assetType/span>span classp>:/span>span classw> /span>span classs2>Image/span>span classp>,/span>span classw> /span>span classs2>ownerType/span>span classp>:/span>span classw> /span>span classs2>merchant/span>span classp>,/span>span classw> /span>span classs2>ownerTypeCaption/span>span classp>:/span>span classw> /span>span classs2>Merchant/span>span classp>,/span>span classw> /span>span classs2>ownerName/span>span classp>:/span>span classw> /span>span classs2>Test Merchant/span>span classp>,/span>span classw> /span>span classs2>previewImage/span>span classp>:/span>span classw> /span>span classs2>https://s3-us-west-2.amazonaws.com/blockchyp-prod-media/media/WY2ZBQWRFEI6ZE6FVTPEQAAREI/UEX46TRTVGPM4STIXH3RLBVOSA/UEX46TRTVGPM4STIXH3RLBVOSA_t.png/span>span classp>,/span>span classw> /span>span classs2>narrativeEffectiveDates/span>span classp>:/span>span classw> /span>span classs2>All Dates/span>span classp>,/span>span classw> /span>span classs2>narrativeDisplayPeriod/span>span classp>:/span>span classw> /span>span classs2>Always/span>span classp>,/span>span classw> /span>span classs2>timeout/span>span classp>:/span>span classw> /span>span classmi>0/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>results/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>47BCQTGXU4I6ZD2MVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>ownerId/span>span classp>:/span>span classw> /span>span classs2>WY2ZBQWRFEI6ZE6FVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>terminalId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>terminalGroupId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>merchantId/span>span classp>:/span>span classw> /span>span classs2>WY2ZBQWRFEI6ZE6FVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>organizationId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>partnerId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>slideShowId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>mediaId/span>span classp>:/span>span classw> /span>span classs2>47BCQLWXU4I6ZD2AVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>padded/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>startDate/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>endDate/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>daysOfWeek/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classmi>5/span>span classw> /span>span classp>,/span>span classw> /span>span classs2>startTime/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>endTime/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>ordinal/span>span classp>:/span>span classw> /span>span classmi>2/span>span classp>,/span>span classw> /span>span classs2>enabled/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>preview/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>userId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>userName/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>thumbnail/span>span classp>:/span>span classw> /span>span classs2>https://s3-us-west-2.amazonaws.com/blockchyp-prod-media/media/WY2ZBQWRFEI6ZE6FVTPEQAAREI/LJT6WBMY3AV7UDR3TXDXWKXFRE_luxe_preview.gif/span>span classp>,/span>span classw> /span>span classs2>lastModified/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>notes/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>editable/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>assetType/span>span classp>:/span>span classw> /span>span classs2>Video/span>span classp>,/span>span classw> /span>span classs2>ownerType/span>span classp>:/span>span classw> /span>span classs2>merchant/span>span classp>,/span>span classw> /span>span classs2>ownerTypeCaption/span>span classp>:/span>span classw> /span>span classs2>Merchant/span>span classp>,/span>span classw> /span>span classs2>ownerName/span>span classp>:/span>span classw> /span>span classs2>Test Merchant/span>span classp>,/span>span classw> /span>span classs2>previewImage/span>span classp>:/span>span classw> /span>span classs2>https://s3-us-west-2.amazonaws.com/blockchyp-prod-media/media/WY2ZBQWRFEI6ZE6FVTPEQAAREI/EXY6PQPFKYZ4SCYKQK5DCQY2ZA_luxe_preview.mp4/span>span classp>,/span>span classw> /span>span classs2>narrativeEffectiveDates/span>span classp>:/span>span classw> /span>span classs2>All Dates/span>span classp>,/span>span classw> /span>span classs2>narrativeDisplayPeriod/span>span classp>:/span>span classw> /span>span classs2>Fri /span>span classp>,/span>span classw> /span>span classs2>timeout/span>span classp>:/span>span classw> /span>span classmi>0/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant, Partner, & Organization/li>li>strong>Required Role:/strong> Media Management/li>/ul>p>This API returns the full branding stack for a given API scope in the order of priority./p>p>Consumers of this API should pay special attention to the code>editable/code> field. This field indicates whether ornot a branding asset is read-only from the perspective of a particular API Credential scope./p>p>The code>thumbnail/code> and code>previewImage/code> attributes can be used to support building user interfaces formanaging the branding stack. code>previewImage/code> differs from code>thumbnail/code> in that the preview image is intended to show how an asset would actually look when displayed on the terminal./p>p>code>activeAsset/code> returns the asset that is currently visible on the terminal./p>h2 idupdate-branding-asset>Update Branding Asset/h2>blockquote>p>Update Branding Asset Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>update-branding-asset/span> -jsonspan classo>/span>span classs2><JSON ENCODED BRANDING ASSET>/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>update-branding-asset/span> -jsonspan classo>/span>span classs2><JSON ENCODED BRANDING ASSET>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>updateBrandingAssetExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>BrandingAsset/span>span classp>{/span>span classx> /span>span classn>MediaID/span>span classo>:/span>span classx> /span>span classs><MEDIA ID>/span>span classp>,/span>span classx> /span>span classn>Padded/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classn>Ordinal/span>span classo>:/span>span classx> /span>span classm>10/span>span classp>,/span>span classx> /span>span classn>StartDate/span>span classo>:/span>span classx> /span>span classs>01/06/2021/span>span classp>,/span>span classx> /span>span classn>StartTime/span>span classo>:/span>span classx> /span>span classs>14:00/span>span classp>,/span>span classx> /span>span classn>EndDate/span>span classo>:/span>span classx> /span>span classs>11/05/2024/span>span classp>,/span>span classx> /span>span classn>EndTime/span>span classo>:/span>span classx> /span>span classs>16:00/span>span classp>,/span>span classx> /span>span classn>Notes/span>span classo>:/span>span classx> /span>span classs>Test Branding Asset/span>span classp>,/span>span classx> /span>span classn>Preview/span>span classo>:/span>span classx> /span>span classno>false/span>span classp>,/span>span classx> /span>span classn>Enabled/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>UpdateBrandingAsset/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>BrandingAsset/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>BrandingAsset/span>span classp>{/span> span classn>MediaId/span> span classp>/span> span classs><MEDIA ID>/span>span classp>,/span> span classn>Padded/span> span classp>/span> span classk>true/span>span classp>,/span> span classn>Ordinal/span> span classp>/span> span classm>10/span>span classp>,/span> span classn>StartDate/span> span classp>/span> span classs>01/06/2021/span>span classp>,/span> span classn>StartTime/span> span classp>/span> span classs>14:00/span>span classp>,/span> span classn>EndDate/span> span classp>/span> span classs>11/05/2024/span>span classp>,/span> span classn>EndTime/span> span classp>/span> span classs>16:00/span>span classp>,/span> span classn>Notes/span> span classp>/span> span classs>Test Branding Asset/span>span classp>,/span> span classn>Preview/span> span classp>/span> span classk>false/span>span classp>,/span> span classn>Enabled/span> span classp>/span> span classk>true/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>BrandingAsset/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>UpdateBrandingAssetAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.BrandingAsset/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.BrandingAsset/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>UpdateBrandingAssetExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>BrandingAsset/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>BrandingAsset/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setMediaId/span>span classo>(/span>span classs><MEDIA ID>/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setPadded/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setOrdinal/span>span classo>(/span>span classmi>10/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setStartDate/span>span classo>(/span>span classs>01/06/2021/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setStartTime/span>span classo>(/span>span classs>14:00/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setEndDate/span>span classo>(/span>span classs>11/05/2024/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setEndTime/span>span classo>(/span>span classs>16:00/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setNotes/span>span classo>(/span>span classs>Test Branding Asset/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setPreview/span>span classo>(/span>span classkc>false/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setEnabled/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classc1>// Send the request/span> span classn>BrandingAsset/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>updateBrandingAsset/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>mediaId/span> span classo>>/span> span classs1><MEDIA ID>/span>span classp>,/span> span classs1>padded/span> span classo>>/span> span classkc>true/span>span classp>,/span> span classs1>ordinal/span> span classo>>/span> span classmi>10/span>span classp>,/span> span classs1>startDate/span> span classo>>/span> span classs1>01/06/2021/span>span classp>,/span> span classs1>startTime/span> span classo>>/span> span classs1>14:00/span>span classp>,/span> span classs1>endDate/span> span classo>>/span> span classs1>11/05/2024/span>span classp>,/span> span classs1>endTime/span> span classo>>/span> span classs1>16:00/span>span classp>,/span> span classs1>notes/span> span classo>>/span> span classs1>Test Branding Asset/span>span classp>,/span> span classs1>preview/span> span classo>>/span> span classkc>false/span>span classp>,/span> span classs1>enabled/span> span classo>>/span> span classkc>true/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>updateBrandingAsset/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>mediaId: /span>span classs1><MEDIA ID>/span>span classp>,/span> span classss>padded: /span>span classkp>true/span>span classp>,/span> span classss>ordinal: /span>span classmi>10/span>span classp>,/span> span classss>startDate: /span>span classs1>01/06/2021/span>span classp>,/span> span classss>startTime: /span>span classs1>14:00/span>span classp>,/span> span classss>endDate: /span>span classs1>11/05/2024/span>span classp>,/span> span classss>endTime: /span>span classs1>16:00/span>span classp>,/span> span classss>notes: /span>span classs1>Test Branding Asset/span>span classp>,/span> span classss>preview: /span>span classkp>false/span>span classp>,/span> span classss>enabled: /span>span classkp>true/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>updateBrandingAsset/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>mediaId/span>span classp>:/span> span classs><MEDIA ID>/span>span classp>,/span> span classs>padded/span>span classp>:/span> span classbp>True/span>span classp>,/span> span classs>ordinal/span>span classp>:/span> span classmi>10/span>span classp>,/span> span classs>startDate/span>span classp>:/span> span classs>01/06/2021/span>span classp>,/span> span classs>startTime/span>span classp>:/span> span classs>14:00/span>span classp>,/span> span classs>endDate/span>span classp>:/span> span classs>11/05/2024/span>span classp>,/span> span classs>endTime/span>span classp>:/span> span classs>16:00/span>span classp>,/span> span classs>notes/span>span classp>:/span> span classs>Test Branding Asset/span>span classp>,/span> span classs>preview/span>span classp>:/span> span classbp>False/span>span classp>,/span> span classs>enabled/span>span classp>:/span> span classbp>True/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>update_branding_asset/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>updateBrandingAsset/span>span classp>({/span> span classna>mediaId/span>span classp>:/span> span classs1><MEDIA ID>/span>span classp>,/span> span classna>padded/span>span classp>:/span> span classkc>true/span>span classp>,/span> span classna>ordinal/span>span classp>:/span> span classmi>10/span>span classp>,/span> span classna>startDate/span>span classp>:/span> span classs1>01/06/2021/span>span classp>,/span> span classna>startTime/span>span classp>:/span> span classs1>14:00/span>span classp>,/span> span classna>endDate/span>span classp>:/span> span classs1>11/05/2024/span>span classp>,/span> span classna>endTime/span>span classp>:/span> span classs1>16:00/span>span classp>,/span> span classna>notes/span>span classp>:/span> span classs1>Test Branding Asset/span>span classp>,/span> span classna>preview/span>span classp>:/span> span classkc>false/span>span classp>,/span> span classna>enabled/span>span classp>:/span> span classkc>true/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>BrandingAsset/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>mediaId/span> span classo>/span> span classs1><MEDIA ID>/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>padded/span> span classo>/span> span classkc>true/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>ordinal/span> span classo>/span> span classmi>10/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>startDate/span> span classo>/span> span classs1>01/06/2021/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>startTime/span> span classo>/span> span classs1>14:00/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>endDate/span> span classo>/span> span classs1>11/05/2024/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>endTime/span> span classo>/span> span classs1>16:00/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>notes/span> span classo>/span> span classs1>Test Branding Asset/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>preview/span> span classo>/span> span classkc>false/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>enabled/span> span classo>/span> span classkc>true/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>updateBrandingAsset/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>BrandingAsset/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>mediaId/span>span classp>/span> span classo>/span> span classs><MEDIA ID>/span> span classn>request/span>span classp>/span>span classs>padded/span>span classp>/span> span classo>/span> span classnb>true/span> span classn>request/span>span classp>/span>span classs>ordinal/span>span classp>/span> span classo>/span> span classmi>10/span> span classn>request/span>span classp>/span>span classs>startDate/span>span classp>/span> span classo>/span> span classs>01/06/2021/span> span classn>request/span>span classp>/span>span classs>startTime/span>span classp>/span> span classo>/span> span classs>14:00/span> span classn>request/span>span classp>/span>span classs>endDate/span>span classp>/span> span classo>/span> span classs>11/05/2024/span> span classn>request/span>span classp>/span>span classs>endTime/span>span classp>/span> span classo>/span> span classs>16:00/span> span classn>request/span>span classp>/span>span classs>notes/span>span classp>/span> span classo>/span> span classs>Test Branding Asset/span> span classn>request/span>span classp>/span>span classs>preview/span>span classp>/span> span classo>/span> span classnb>false/span> span classn>request/span>span classp>/span>span classs>enabled/span>span classp>/span> span classo>/span> span classnb>true/span> span classp>/span>span classn>client/span> span classnf>updateBrandingAssetWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>mediaId/span>span classp>/span> span classo>/span> span classs><MEDIA ID>/span> span classn>request/span>span classp>/span>span classs>padded/span>span classp>/span> span classo>/span> span classkc>true/span> span classn>request/span>span classp>/span>span classs>ordinal/span>span classp>/span> span classo>/span> span classmi>10/span> span classn>request/span>span classp>/span>span classs>startDate/span>span classp>/span> span classo>/span> span classs>01/06/2021/span> span classn>request/span>span classp>/span>span classs>startTime/span>span classp>/span> span classo>/span> span classs>14:00/span> span classn>request/span>span classp>/span>span classs>endDate/span>span classp>/span> span classo>/span> span classs>11/05/2024/span> span classn>request/span>span classp>/span>span classs>endTime/span>span classp>/span> span classo>/span> span classs>16:00/span> span classn>request/span>span classp>/span>span classs>notes/span>span classp>/span> span classo>/span> span classs>Test Branding Asset/span> span classn>request/span>span classp>/span>span classs>preview/span>span classp>/span> span classo>/span> span classkc>false/span> span classn>request/span>span classp>/span>span classs>enabled/span>span classp>/span> span classo>/span> span classkc>true/span> span classn>client/span>span classo>./span>span classnf>updateBrandingAsset/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>update_branding_asset_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>BrandingAsset/span>span classp>{/span> span classn>media_id/span>span classp>:/span> span classs><MEDIA ID>/span>span classnf>.to_string/span>span classp>(),/span> span classn>padded/span>span classp>:/span> span classk>true/span>span classp>,/span> span classn>ordinal/span>span classp>:/span> span classmi>10/span>span classp>,/span> span classn>start_date/span>span classp>:/span> span classs>01/06/2021/span>span classnf>.to_string/span>span classp>(),/span> span classn>start_time/span>span classp>:/span> span classs>14:00/span>span classnf>.to_string/span>span classp>(),/span> span classn>end_date/span>span classp>:/span> span classs>11/05/2024/span>span classnf>.to_string/span>span classp>(),/span> span classn>end_time/span>span classp>:/span> span classs>16:00/span>span classnf>.to_string/span>span classp>(),/span> span classn>notes/span>span classp>:/span> span classs>Test Branding Asset/span>span classnf>.to_string/span>span classp>(),/span> span classn>preview/span>span classp>:/span> span classk>false/span>span classp>,/span> span classn>enabled/span>span classp>:/span> span classk>true/span>span classp>,/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.update_branding_asset/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>update_branding_asset_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>KCSZJAG4PII6ZE73VTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>ownerId/span>span classp>:/span>span classw> /span>span classs2>WY2ZBQWRFEI6ZE6FVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>terminalId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>terminalGroupId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>merchantId/span>span classp>:/span>span classw> /span>span classs2>WY2ZBQWRFEI6ZE6FVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>organizationId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>partnerId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>slideShowId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>mediaId/span>span classp>:/span>span classw> /span>span classs2>KCSZI3G4PII6ZE7YVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>padded/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>startDate/span>span classp>:/span>span classw> /span>span classs2>2021-01-06/span>span classp>,/span>span classw> /span>span classs2>endDate/span>span classp>:/span>span classw> /span>span classs2>2024-11-05/span>span classp>,/span>span classw> /span>span classs2>daysOfWeek/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classs2>startTime/span>span classp>:/span>span classw> /span>span classs2>14:00/span>span classp>,/span>span classw> /span>span classs2>endTime/span>span classp>:/span>span classw> /span>span classs2>16:00/span>span classp>,/span>span classw> /span>span classs2>ordinal/span>span classp>:/span>span classw> /span>span classmi>7/span>span classp>,/span>span classw> /span>span classs2>enabled/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>preview/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>userId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>userName/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>thumbnail/span>span classp>:/span>span classw> /span>span classs2>https://s3-us-west-2.amazonaws.com/blockchyp-prod-media/media/WY2ZBQWRFEI6ZE6FVTPEQAAREI/O67KRLGPIKGVLLQWDN2ZJWIXME/O67KRLGPIKGVLLQWDN2ZJWIXME_t.png/span>span classp>,/span>span classw> /span>span classs2>lastModified/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>notes/span>span classp>:/span>span classw> /span>span classs2>Test Branding Asset/span>span classp>,/span>span classw> /span>span classs2>editable/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>assetType/span>span classp>:/span>span classw> /span>span classs2>Image/span>span classp>,/span>span classw> /span>span classs2>ownerType/span>span classp>:/span>span classw> /span>span classs2>merchant/span>span classp>,/span>span classw> /span>span classs2>ownerTypeCaption/span>span classp>:/span>span classw> /span>span classs2>Merchant/span>span classp>,/span>span classw> /span>span classs2>ownerName/span>span classp>:/span>span classw> /span>span classs2>Gangster Test Merchant/span>span classp>,/span>span classw> /span>span classs2>previewImage/span>span classp>:/span>span classw> /span>span classs2>https://s3-us-west-2.amazonaws.com/blockchyp-prod-media/media/WY2ZBQWRFEI6ZE6FVTPEQAAREI/O67KRLGPIKGVLLQWDN2ZJWIXME/O67KRLGPIKGVLLQWDN2ZJWIXME_t.png/span>span classp>,/span>span classw> /span>span classs2>narrativeEffectiveDates/span>span classp>:/span>span classw> /span>span classs2>01/06/2021 through 11/05/2024/span>span classp>,/span>span classw> /span>span classs2>narrativeDisplayPeriod/span>span classp>:/span>span classw> /span>span classs2>14:00 Through 16:00/span>span classp>,/span>span classw> /span>span classs2>timeout/span>span classp>:/span>span classw> /span>span classmi>0/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant, Partner, & Organization/li>li>strong>Required Role:/strong> Media Management/li>/ul>p>This API updates or creates a single Branding Asset./p>p>Branding Assets represent a single element of the terminal branding stack. A Branding Asset can be a video or image,in which case a code>mediaId/code> referencing an asset from the media library must be provided. A Branding Asset can alsobe a slide show, in which case code>slideShowId/code> must be provided. Branding Assets must have a valid code>mediaId/code> or a validcode>slideShowId/code>. The optional code>notes/code> field can be used to provide short notes and descriptions for a Branding asset./p>p>strong>Visibility Flags/strong>/p>p>In order for a Branding Asset to be visible on a terminal, the code>enabled/code> flag must be set to true and the code>preview/code>must be turned off. code>preview/code> is intended to show how a proposed Branding Asset will behavewithout pushing it to live terminals. The Publish button in the BlockChyp merchant portal effectively turnsthe code>preview/code> setting off./p>p>strong>Order and Sequencing/strong>/p>p>The code>ordinal/code> field is used to specify priority for a Branding Asset. Assets with a higher value for code>ordinal/code>will be prioritized first./p>p>strong>Padding Images/strong>/p>p>For plain images, it's sometimes helpful to add margins to images. This is especially helpful with logosor any image file rendered without any white space or margins between the image content and edge of the image file.Set the code>padded/code> flag to true if you'd like BlockChyp to auto apply margins when displaying an image on the terminal./p>p>strong>Scheduling/strong>/p>p>By default, a Branding Asset placed on top of the Branding Stack, if it's code>enabled/code> and not in code>preview/code>mode, will immediately be displayed on the terminal round the clock./p>p>Branding Assets can be scheduled with effective start and stop dates for seasonal campaigns. These assets canalso be scheduled for specific times of day and specific days of the week./p>ul>li>strong>startDate:/strong> Optional date after which the Branding Asset is eligible for display. Can be provided in MM/DD/YYYY or YYYY-MM-DD format./li>li>strong>endDate:/strong> Optional date before which the Branding Asset is eligible for display. Can be provided in MM/DD/YYYY or YYYY-MM-DD format./li>li>strong>startTime/strong> Optional time of day after which the branding asset is eligible for display. Must be provided in 24 hour time: HH:MM./li>li>strong>endTime/strong> Optional time of day before which the branding asset is eligible for display. Must be provided in 24 hour time format: HH:MM/li>li>strong>daysOfWeek/strong> For branding assets that should only be displayed on certain days of the week, this field is an array of day of the week constants. (Constants vary by SDK platform.)/li>/ul>p>strong>Read Only Fields/strong>/p>p>The Branding Asset data structure has a number of read only fields that are returned when Branding Assets are retrieved. But these fields are ignored when you try to send them as part of an update. These are derivedor calculated fields and are helpful for displaying branding assets in a management user interface, but cannot be changed via an API call./p>p>These fields are:/p>ul>li>ownerId/li>li>merchantId/li>li>organizationId/li>li>partnerId/li>li>userId/li>li>userName/li>li>thumbnail/li>li>lastModified/li>li>editable/li>li>assetType/li>li>ownerType/li>li>ownerTypeCaption/li>li>previewImage/li>li>narrativeEffectiveDates/li>li>narrativeDisplayPeriod/li>/ul>h2 iddelete-branding-asset>Delete Branding Asset/h2>blockquote>p>Delete Branding Asset Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>delete-branding-asset/span> -assetIdspan classo>/span>span classs2><BRANDING ASSET ID>/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>delete-branding-asset/span> -assetIdspan classo>/span>span classs2><BRANDING ASSET ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>deleteBrandingAssetExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>BrandingAssetRequest/span>span classp>{/span>span classx> /span>span classn>AssetID/span>span classo>:/span>span classx> /span>span classs><BRANDING ASSET ID>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>DeleteBrandingAsset/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>BrandingAssetRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>BrandingAssetRequest/span>span classp>{/span> span classn>AssetId/span> span classp>/span> span classs><BRANDING ASSET ID>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>Acknowledgement/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>DeleteBrandingAssetAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.BrandingAssetRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.Acknowledgement/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>DeleteBrandingAssetExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>BrandingAssetRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>BrandingAssetRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setAssetId/span>span classo>(/span>span classs><BRANDING ASSET ID>/span>span classo>);/span> span classc1>// Send the request/span> span classn>Acknowledgement/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>deleteBrandingAsset/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>assetId/span> span classo>>/span> span classs1><BRANDING ASSET ID>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>deleteBrandingAsset/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>assetId: /span>span classs1><BRANDING ASSET ID>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>deleteBrandingAsset/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>assetId/span>span classp>:/span> span classs><BRANDING ASSET ID>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>delete_branding_asset/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>deleteBrandingAsset/span>span classp>({/span> span classna>assetId/span>span classp>:/span> span classs1><BRANDING ASSET ID>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>BrandingAssetRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>assetId/span> span classo>/span> span classs1><BRANDING ASSET ID>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>deleteBrandingAsset/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>Acknowledgement/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>assetId/span>span classp>/span> span classo>/span> span classs><BRANDING ASSET ID>/span> span classp>/span>span classn>client/span> span classnf>deleteBrandingAssetWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>assetId/span>span classp>/span> span classo>/span> span classs><BRANDING ASSET ID>/span> span classn>client/span>span classo>./span>span classnf>deleteBrandingAsset/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>delete_branding_asset_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>BrandingAssetRequest/span>span classp>{/span> span classn>asset_id/span>span classp>:/span> span classs><BRANDING ASSET ID>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.delete_branding_asset/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>delete_branding_asset_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant, Partner, & Organization/li>li>strong>Required Role:/strong> Media Management/li>/ul>p>This API deletes a Branding Asset from the branding stack./p>p>Note that deleting a Branding Asset does not delete the underlying media from the media library or slideshow from the slide show library./p>h1 idmerchant-api>Merchant API/h1>p>These APIs allow partners to manage and configure their merchant portfolios./p>p>Use of these APIs (other than the Merchant Profile API) requires partner scoped API credentialswith special roles and permissions that may require a special arrangement with BlockChyp./p>p>For example, Partners usually can't board merchants directly, but must board merchants usingthe standard underwriting process via offer codes and invitations./p>h2 idmerchant-profile>Merchant Profile/h2>blockquote>p>Merchant Profile Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>merchant-profile/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>merchant-profile/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>merchantProfileExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>MerchantProfileRequest/span>span classp>{}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>MerchantProfile/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>MerchantProfileRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>MerchantProfileRequest/span>span classp>{/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>MerchantProfileResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>MerchantProfileAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.MerchantProfileRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.MerchantProfileResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>MerchantProfileExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>MerchantProfileRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>MerchantProfileRequest/span>span classo>();/span> span classc1>// Send the request/span> span classn>MerchantProfileResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>merchantProfile/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>merchantProfile/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>merchantProfile/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>merchant_profile/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>merchantProfile/span>span classp>({/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>MerchantProfileRequest/span>span classp>();/span>span classnx>client/span>span classp>./span>span classnx>merchantProfile/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>MerchantProfileResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classp>/span>span classn>client/span> span classnf>merchantProfileWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>client/span>span classo>./span>span classnf>merchantProfile/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>merchant_profile_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>MerchantProfileRequest/span>span classp>{/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.merchant_profile/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>merchant_profile_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>timeout/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>merchantId/span>span classp>:/span>span classw> /span>span classs2>WY2ZBQWRFEI6ZE6FVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>companyName/span>span classp>:/span>span classw> /span>span classs2>Test Merchant/span>span classp>,/span>span classw> /span>span classs2>dbaName/span>span classp>:/span>span classw> /span>span classs2>Test Merchant/span>span classp>,/span>span classw> /span>span classs2>contactName/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>contactNumber/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>locationName/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>storeNumber/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>partnerRef/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>timeZone/span>span classp>:/span>span classw> /span>span classs2>America/New_York/span>span classp>,/span>span classw> /span>span classs2>batchCloseTime/span>span classp>:/span>span classw> /span>span classs2>03:00/span>span classp>,/span>span classw> /span>span classs2>terminalUpdateTime/span>span classp>:/span>span classw> /span>span classs2>03:00/span>span classp>,/span>span classw> /span>span classs2>autoBatchClose/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>disableBatchEmails/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>pinEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>cashBackEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>storeAndForwardEnabled/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>partialAuthEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>splitBankAccountsEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>storeAndForwardFloorLimit/span>span classp>:/span>span classw> /span>span classs2>50.00/span>span classp>,/span>span classw> /span>span classs2>publicKey/span>span classp>:/span>span classw> /span>span classs2>112cB2d5obZ2dFdLNWY4rZ1e62ppU7RRV7QMDbgmERYkt1DYLg2L/span>span classp>,/span>span classw> /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>active/span>span classp>,/span>span classw> /span>span classs2>cashDiscountEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>surveyTimeout/span>span classp>:/span>span classw> /span>span classmi>90/span>span classp>,/span>span classw> /span>span classs2>cooldownTimeout/span>span classp>:/span>span classw> /span>span classmi>30/span>span classp>,/span>span classw> /span>span classs2>tipEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>promptForTip/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>tipDefaults/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classs2>15%/span>span classp>,/span>span classw> /span>span classs2>20%/span>span classp>,/span>span classw> /span>span classs2>25%/span>span classw> /span>span classp>,/span>span classw> /span>span classs2>cashbackPresets/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classs2>1.00/span>span classp>,/span>span classw> /span>span classs2>10.00/span>span classp>,/span>span classw> /span>span classs2>20.00/span>span classp>,/span>span classw> /span>span classs2>50.00/span>span classw> /span>span classp>,/span>span classw> /span>span classs2>ebtEnabled/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>freeRangeRefundsEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>pinBypassEnabled/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>giftCardsDisabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>tcDisabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>digitalSignaturesEnabled/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>digitalSignatureReversal/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>billingAddress/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>address1/span>span classp>:/span>span classw> /span>span classs2>1060 West Addison/span>span classp>,/span>span classw> /span>span classs2>address2/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>city/span>span classp>:/span>span classw> /span>span classs2>Chicago/span>span classp>,/span>span classw> /span>span classs2>stateOrProvince/span>span classp>:/span>span classw> /span>span classs2>IL/span>span classp>,/span>span classw> /span>span classs2>postalCode/span>span classp>:/span>span classw> /span>span classs2>60613/span>span classp>,/span>span classw> /span>span classs2>countryCode/span>span classp>:/span>span classw> /span>span classs2>USA/span>span classp>,/span>span classw> /span>span classs2>latitude/span>span classp>:/span>span classw> /span>span classmf>41.942329564/span>span classp>,/span>span classw> /span>span classs2>longitude/span>span classp>:/span>span classw> /span>span classmf>-87.65333072/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>shippingAddress/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>address1/span>span classp>:/span>span classw> /span>span classs2>1060 West Addison/span>span classp>,/span>span classw> /span>span classs2>address2/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>city/span>span classp>:/span>span classw> /span>span classs2>Chicago/span>span classp>,/span>span classw> /span>span classs2>stateOrProvince/span>span classp>:/span>span classw> /span>span classs2>IL/span>span classp>,/span>span classw> /span>span classs2>postalCode/span>span classp>:/span>span classw> /span>span classs2>60613/span>span classp>,/span>span classw> /span>span classs2>countryCode/span>span classp>:/span>span classw> /span>span classs2>USA/span>span classp>,/span>span classw> /span>span classs2>latitude/span>span classp>:/span>span classw> /span>span classmf>41.942329564/span>span classp>,/span>span classw> /span>span classs2>longitude/span>span classp>:/span>span classw> /span>span classmf>-87.65333072/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>visa/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>masterCard/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>amex/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>discover/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>jcb/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>unionPay/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>contactlessEmv/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>manualEntryEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>manualEntryPromptZip/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>manualEntryPromptStreetNumber/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>gatewayOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>The API returns detailed metadata about the merchant's configuration, includingbasic identity information, terminal settings, store and forward settings,and bank account information for merchants that support split settlement./p>p>Some of these fields can be updated via the Update Merchant API, but many of thesefields are controlled by underwriting and cannot be altered outside of the underwriting and risk processes./p>p>strong>Merchant Descriptive Fields/strong>/p>p>The following fields are basic descriptive fields that can be used to describe and identify merchants./p>ul>li>strong>companyName:/strong> The merchant's official corporate entity name./li>li>strong>dbaName:/strong> The business's DBA (doing business as) name./li>li>strong>contactName:/strong> Name of the merchant's primary control contact./li>li>strong>contactNumber:/strong> Primary control contact's phone number./li>li>strong>locationName:/strong> Optional location name for multi-location operators./li>li>strong>storeNumber:/strong> Optional store number for multi-location operators./li>li>strong>partnerRef:/strong> Optional reference number partners can add to a merchant record. Usually the partner's own identifier for the merchant./li>li>strong>timeZone:/strong> Unix style local time zone for the merchant. Example: America/New_York./li>li>strong>publicKey:/strong> Read only field. The merchant's blockchain public key. Generated and assigned when a merchant account is first created./li>li>strong>billingAddress:/strong> Address for billing and written correspondence./li>li>strong>shippingAddress:/strong> Physical shipping address. Usually the actual street address of the business./li>li>strong>status:/strong> Current status of the merchant account./li>li>strong>tcDisabled:/strong> Disables all terms and conditions features in the merchant dashboard. Used to hide the feature if a partner has not chosen to support it./li>li>strong>gatewayOnly:/strong> Indicates that a merchant has been boarded in gateway only mode. Not common./li>/ul>p>strong>Batch and Terminal Settings/strong>/p>p>The following fields are used to control batch closure and high level terminal configuration./p>ul>li>strong>batchCloseTime:/strong> Time in 24 hour HH:MM format when batches will automatically close in the merchant's local time. Defaults to 3 AM./li>li>strong>autoBatchClose:/strong> Flag the determines whether or not batches will automatically close. Defaults to true./li>li>strong>disableBatchEmails:/strong> Flag that optionally turns off automatic batch closure notification emails./li>li>strong>cooldownTimeout:/strong> The amount of time in seconds after a transactions for which the transaction response is displayed on the terminal. After the cooldown period elapses, the terminal will revert to the idle state and display the currently active terminal branding./li>li>strong>surveyTimeout:/strong> The amount of time in seconds a survey question should be displayed on a terminal before reverting to the idle screen./li>li>strong>pinEnabled:/strong> Enables pin code entry for debit cards, EBT cards, and EMV cards with pin CVMs. Will be ignored if terminals are not injected with the proper encryption keys./li>li>strong>pinBypassEnabled:/strong> Enable pin bypass for debit transactions./li>li>strong>cashBackEnabled:/strong> Enables cash back for debit transactions./li>li>strong>cashbackPresets:/strong> An array of four default values for cashback amounts when cashback is enabled./li>li>strong>storeAndForwardEnabled:/strong> Enables automatic store and forward during network outages. Store and Forward does not support cash back, refunds, EBT, or gift card transactions./li>li>strong>storeAndForwardFloorLimit:/strong> Maximum dollar value of a store and forward transaction./li>li>strong>ebtEnabled:/strong> Enables EBT (SNAP) on BlockChyp terminals./li>li>strong>tipEnabled:/strong> Enables tips entry on the terminal./li>li>strong>promptForTip:/strong> If true, the terminal will always prompt for a tip, even if the API call does not request a tip prompt./li>li>strong>tipDefaults:/strong> An array of exactly three percentages that will be used to calculate default tip amounts./li>li>strong>giftCardsDisabled:/strong> Disables BlockChyp gift cards. Normally only used if the merchant is using an alternate gift card system./li>li>strong>digitalSignaturesEnabled:/strong> Enables electronic signature capture for mag stripe cards and EMV cards with Signature CVMs./li>li>strong>digitalSignatureReversal:/strong> Will cause a transaction to auto-reverse if the consumer refuses to provide a signature./li>li>strong>manualEntryEnabled:/strong> Enables manual card entry./li>li>strong>manualEntryPromptZip:/strong> Requires zip code based address verification for manual card entry./li>li>strong>manualEntryPromptStreetNumber:/strong> Requires street/address based verification for manual card entry./li>/ul>p>strong>Card Brand and Transaction Settings/strong>/p>ul>li>strong>freeRangeRefundsEnabled:/strong> Enables direct refunds that do not reference a previous transaction./li>li>strong>partialAuthEnabled:/strong> Indicates that partial authorizations (usually for gift card support) are enabled./li>li>strong>splitBankAccountsEnabled:/strong> Used for law firm merchants only./li>li>strong>contactlessEmv:/strong> Enables contactless/tap transactions on a terminal. Defaults to true./li>li>strong>visa:/strong> Enables Visa transactions./li>li>strong>masterCard:/strong> Enables MasterCard transactions./li>li>strong>amex:/strong> Enables American Express transactions./li>li>strong>discover:/strong> Enables Discover transactions./li>li>strong>jcb:/strong> Enables JCB (Japan Card Bureau) transactions./li>li>strong>unionPay:/strong> Enables China UnionPay transactions./li>/ul>h2 idget-merchants>Get Merchants/h2>blockquote>p>Get Merchants Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>get-merchants/span> -testWindows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>get-merchants/span> -test/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>getMerchantsExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>GetMerchantsRequest/span>span classp>{/span>span classx> /span>span classn>Test/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>GetMerchants/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>GetMerchantsRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>GetMerchantsRequest/span>span classp>{/span> span classn>Test/span> span classp>/span> span classk>true/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>GetMerchantsResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>GetMerchantsAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.GetMerchantsRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.GetMerchantsResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>GetMerchantsExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>GetMerchantsRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>GetMerchantsRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTest/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classc1>// Send the request/span> span classn>GetMerchantsResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>getMerchants/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>test/span> span classo>>/span> span classkc>true/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>getMerchants/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>test: /span>span classkp>true/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>getMerchants/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>test/span>span classp>:/span> span classbp>True/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>get_merchants/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>getMerchants/span>span classp>({/span> span classna>test/span>span classp>:/span> span classkc>true/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>GetMerchantsRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>test/span> span classo>/span> span classkc>true/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>getMerchants/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>GetMerchantsResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classnb>true/span> span classp>/span>span classn>client/span> span classnf>getMerchantsWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classkc>true/span> span classn>client/span>span classo>./span>span classnf>getMerchants/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>get_merchants_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>GetMerchantsRequest/span>span classp>{/span> span classn>test/span>span classp>:/span> span classk>true/span>span classp>,/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.get_merchants/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>get_merchants_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>maxResults/span>span classp>:/span>span classw> /span>span classmi>250/span>span classp>,/span>span classw> /span>span classs2>startIndex/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>resultCount/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>merchants/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>timeout/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>merchantId/span>span classp>:/span>span classw> /span>span classs2>WY2ZBQWRFEI6ZE6FVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>companyName/span>span classp>:/span>span classw> /span>span classs2>Test Merchant/span>span classp>,/span>span classw> /span>span classs2>dbaName/span>span classp>:/span>span classw> /span>span classs2>Test Merchant/span>span classp>,/span>span classw> /span>span classs2>contactName/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>contactNumber/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>locationName/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>storeNumber/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>partnerRef/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>timeZone/span>span classp>:/span>span classw> /span>span classs2>America/New_York/span>span classp>,/span>span classw> /span>span classs2>batchCloseTime/span>span classp>:/span>span classw> /span>span classs2>03:00/span>span classp>,/span>span classw> /span>span classs2>terminalUpdateTime/span>span classp>:/span>span classw> /span>span classs2>03:00/span>span classp>,/span>span classw> /span>span classs2>autoBatchClose/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>disableBatchEmails/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>pinEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>cashBackEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>storeAndForwardEnabled/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>partialAuthEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>splitBankAccountsEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>storeAndForwardFloorLimit/span>span classp>:/span>span classw> /span>span classs2>50.00/span>span classp>,/span>span classw> /span>span classs2>publicKey/span>span classp>:/span>span classw> /span>span classs2>112cB2d5obZ2dFdLNWY4rZ1e62ppU7RRV7QMDbgmERYkt1DYLg2L/span>span classp>,/span>span classw> /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>active/span>span classp>,/span>span classw> /span>span classs2>cashDiscountEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>surveyTimeout/span>span classp>:/span>span classw> /span>span classmi>90/span>span classp>,/span>span classw> /span>span classs2>cooldownTimeout/span>span classp>:/span>span classw> /span>span classmi>30/span>span classp>,/span>span classw> /span>span classs2>tipEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>promptForTip/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>tipDefaults/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classs2>15%/span>span classp>,/span>span classw> /span>span classs2>20%/span>span classp>,/span>span classw> /span>span classs2>25%/span>span classw> /span>span classp>,/span>span classw> /span>span classs2>cashbackPresets/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classs2>1.00/span>span classp>,/span>span classw> /span>span classs2>10.00/span>span classp>,/span>span classw> /span>span classs2>20.00/span>span classp>,/span>span classw> /span>span classs2>50.00/span>span classw> /span>span classp>,/span>span classw> /span>span classs2>ebtEnabled/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>freeRangeRefundsEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>pinBypassEnabled/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>giftCardsDisabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>tcDisabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>digitalSignaturesEnabled/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>digitalSignatureReversal/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>billingAddress/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>address1/span>span classp>:/span>span classw> /span>span classs2>1060 West Addison/span>span classp>,/span>span classw> /span>span classs2>address2/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>city/span>span classp>:/span>span classw> /span>span classs2>Chicago/span>span classp>,/span>span classw> /span>span classs2>stateOrProvince/span>span classp>:/span>span classw> /span>span classs2>IL/span>span classp>,/span>span classw> /span>span classs2>postalCode/span>span classp>:/span>span classw> /span>span classs2>60613/span>span classp>,/span>span classw> /span>span classs2>countryCode/span>span classp>:/span>span classw> /span>span classs2>USA/span>span classp>,/span>span classw> /span>span classs2>latitude/span>span classp>:/span>span classw> /span>span classmf>41.942329564/span>span classp>,/span>span classw> /span>span classs2>longitude/span>span classp>:/span>span classw> /span>span classmf>-87.65333072/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>shippingAddress/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>address1/span>span classp>:/span>span classw> /span>span classs2>1060 West Addison/span>span classp>,/span>span classw> /span>span classs2>address2/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>city/span>span classp>:/span>span classw> /span>span classs2>Chicago/span>span classp>,/span>span classw> /span>span classs2>stateOrProvince/span>span classp>:/span>span classw> /span>span classs2>IL/span>span classp>,/span>span classw> /span>span classs2>postalCode/span>span classp>:/span>span classw> /span>span classs2>60613/span>span classp>,/span>span classw> /span>span classs2>countryCode/span>span classp>:/span>span classw> /span>span classs2>USA/span>span classp>,/span>span classw> /span>span classs2>latitude/span>span classp>:/span>span classw> /span>span classmf>41.942329564/span>span classp>,/span>span classw> /span>span classs2>longitude/span>span classp>:/span>span classw> /span>span classmf>-87.65333072/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>visa/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>masterCard/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>amex/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>discover/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>jcb/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>unionPay/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>contactlessEmv/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>manualEntryEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>manualEntryPromptZip/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>manualEntryPromptStreetNumber/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>gatewayOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Partner & Organization/li>li>strong>Required Role:/strong> Merchant Management/li>/ul>p>This is a partner or organization level API that can be used to return the merchant portfolio./p>p>Live merchants are returned by default. Use the code>test/code> flag to return only test merchants. The results returned include detailed settings including underwriting controlled flags./p>p>A maximum of 250 merchants are returned by default. For large merchant portfolios, the code>maxResults/code>and code>startIndex/code> field can be used to reduce the page size and page through multiple pages of results./p>h2 idupdate-merchant>Update Merchant/h2>blockquote>p>Update Merchant Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>update-merchant/span> -jsonspan classo>/span>span classs2>{JSON ENCODED MERCHANT PROFILE}/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>update-merchant/span> -jsonspan classo>/span>span classs2>{JSON ENCODED MERCHANT PROFILE}/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>updateMerchantExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>MerchantProfile/span>span classp>{/span>span classx> /span>span classn>MerchantID/span>span classo>:/span>span classx> /span>span classs><MERCHANT ID>/span>span classp>,/span>span classx> /span>span classn>Test/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classn>DBAName/span>span classo>:/span>span classx> /span>span classs>Test Merchant/span>span classp>,/span>span classx> /span>span classn>CompanyName/span>span classo>:/span>span classx> /span>span classs>Test Merchant/span>span classp>,/span>span classx> /span>span classn>BillingAddress/span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>Address/span>span classp>{/span>span classx> /span>span classn>Address1/span>span classo>:/span>span classx> /span>span classs>1060 West Addison/span>span classp>,/span>span classx> /span>span classn>City/span>span classo>:/span>span classx> /span>span classs>Chicago/span>span classp>,/span>span classx> /span>span classn>StateOrProvince/span>span classo>:/span>span classx> /span>span classs>IL/span>span classp>,/span>span classx> /span>span classn>PostalCode/span>span classo>:/span>span classx> /span>span classs>60613/span>span classp>,/span>span classx> /span>span classp>},/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>UpdateMerchant/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>MerchantProfile/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>MerchantProfile/span>span classp>{/span> span classn>MerchantId/span> span classp>/span> span classs><MERCHANT ID>/span>span classp>,/span> span classn>Test/span> span classp>/span> span classk>true/span>span classp>,/span> span classn>DbaName/span> span classp>/span> span classs>Test Merchant/span>span classp>,/span> span classn>CompanyName/span> span classp>/span> span classs>Test Merchant/span>span classp>,/span> span classn>BillingAddress/span> span classp>/span> span classk>new/span> span classn>Address/span> span classp>{/span> span classn>Address1/span> span classp>/span> span classs>1060 West Addison/span>span classp>,/span> span classn>City/span> span classp>/span> span classs>Chicago/span>span classp>,/span> span classn>StateOrProvince/span> span classp>/span> span classs>IL/span>span classp>,/span> span classn>PostalCode/span> span classp>/span> span classs>60613/span>span classp>,/span> span classp>},/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>MerchantProfileResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>UpdateMerchantAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.MerchantProfile/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.MerchantProfileResponse/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.Address/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>UpdateMerchantExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>MerchantProfile/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>MerchantProfile/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setMerchantId/span>span classo>(/span>span classs><MERCHANT ID>/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setTest/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setDbaName/span>span classo>(/span>span classs>Test Merchant/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setCompanyName/span>span classo>(/span>span classs>Test Merchant/span>span classo>);/span> span classn>Address/span> span classn>billingAddress/span> span classo>/span> span classk>new/span> span classn>Address/span>span classo>();/span> span classn>billingAddress/span>span classo>./span>span classna>setAddress1/span>span classo>(/span>span classs>1060 West Addison/span>span classo>);/span> span classn>billingAddress/span>span classo>./span>span classna>setCity/span>span classo>(/span>span classs>Chicago/span>span classo>);/span> span classn>billingAddress/span>span classo>./span>span classna>setStateOrProvince/span>span classo>(/span>span classs>IL/span>span classo>);/span> span classn>billingAddress/span>span classo>./span>span classna>setPostalCode/span>span classo>(/span>span classs>60613/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setBillingAddress/span>span classo>(/span>span classn>billingAddress/span>span classo>);/span> span classc1>// Send the request/span> span classn>MerchantProfileResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>updateMerchant/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>merchantId/span> span classo>>/span> span classs1><MERCHANT ID>/span>span classp>,/span> span classs1>test/span> span classo>>/span> span classkc>true/span>span classp>,/span> span classs1>dbaName/span> span classo>>/span> span classs1>Test Merchant/span>span classp>,/span> span classs1>companyName/span> span classo>>/span> span classs1>Test Merchant/span>span classp>,/span> span classs1>billingAddress/span> span classo>>/span> span classp>/span> span classs1>address1/span> span classo>>/span> span classs1>1060 West Addison/span>span classp>,/span> span classs1>city/span> span classo>>/span> span classs1>Chicago/span>span classp>,/span> span classs1>stateOrProvince/span> span classo>>/span> span classs1>IL/span>span classp>,/span> span classs1>postalCode/span> span classo>>/span> span classs1>60613/span>span classp>,/span> span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>updateMerchant/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>merchantId: /span>span classs1><MERCHANT ID>/span>span classp>,/span> span classss>test: /span>span classkp>true/span>span classp>,/span> span classss>dbaName: /span>span classs1>Test Merchant/span>span classp>,/span> span classss>companyName: /span>span classs1>Test Merchant/span>span classp>,/span> span classss>billingAddress: /span>span classp>{/span> span classss>address1: /span>span classs1>1060 West Addison/span>span classp>,/span> span classss>city: /span>span classs1>Chicago/span>span classp>,/span> span classss>stateOrProvince: /span>span classs1>IL/span>span classp>,/span> span classss>postalCode: /span>span classs1>60613/span> span classp>}/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>updateMerchant/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>merchantId/span>span classp>:/span> span classs><MERCHANT ID>/span>span classp>,/span> span classs>test/span>span classp>:/span> span classbp>True/span>span classp>,/span> span classs>dbaName/span>span classp>:/span> span classs>Test Merchant/span>span classp>,/span> span classs>companyName/span>span classp>:/span> span classs>Test Merchant/span>span classp>,/span> span classs>billingAddress/span>span classp>:/span> span classp>{/span> span classs>address1/span>span classp>:/span> span classs>1060 West Addison/span>span classp>,/span> span classs>city/span>span classp>:/span> span classs>Chicago/span>span classp>,/span> span classs>stateOrProvince/span>span classp>:/span> span classs>IL/span>span classp>,/span> span classs>postalCode/span>span classp>:/span> span classs>60613/span>span classp>,/span> span classp>},/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>update_merchant/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>updateMerchant/span>span classp>({/span> span classna>merchantId/span>span classp>:/span> span classs1><MERCHANT ID>/span>span classp>,/span> span classna>test/span>span classp>:/span> span classkc>true/span>span classp>,/span> span classna>dbaName/span>span classp>:/span> span classs1>Test Merchant/span>span classp>,/span> span classna>companyName/span>span classp>:/span> span classs1>Test Merchant/span>span classp>,/span> span classna>billingAddress/span>span classp>:/span> span classp>{/span> span classna>address1/span>span classp>:/span> span classs1>1060 West Addison/span>span classp>,/span> span classna>city/span>span classp>:/span> span classs1>Chicago/span>span classp>,/span> span classna>stateOrProvince/span>span classp>:/span> span classs1>IL/span>span classp>,/span> span classna>postalCode/span>span classp>:/span> span classs1>60613/span>span classp>,/span> span classp>},/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>MerchantProfile/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>merchantId/span> span classo>/span> span classs1><MERCHANT ID>/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>test/span> span classo>/span> span classkc>true/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>dbaName/span> span classo>/span> span classs1>Test Merchant/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>companyName/span> span classo>/span> span classs1>Test Merchant/span>span classp>;/span>span classkd>const/span> span classnx>billingAddress/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>Address/span>span classp>();/span>span classnx>billingAddress/span>span classp>./span>span classnx>address1/span> span classo>/span> span classs1>1060 West Addison/span>span classp>;/span>span classnx>billingAddress/span>span classp>./span>span classnx>city/span> span classo>/span> span classs1>Chicago/span>span classp>;/span>span classnx>billingAddress/span>span classp>./span>span classnx>stateOrProvince/span> span classo>/span> span classs1>IL/span>span classp>;/span>span classnx>billingAddress/span>span classp>./span>span classnx>postalCode/span> span classo>/span> span classs1>60613/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>billingAddress/span> span classo>/span> span classnx>billingAddress/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>updateMerchant/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>MerchantProfileResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>merchantId/span>span classp>/span> span classo>/span> span classs><MERCHANT ID>/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classnb>true/span> span classn>request/span>span classp>/span>span classs>dbaName/span>span classp>/span> span classo>/span> span classs>Test Merchant/span> span classn>request/span>span classp>/span>span classs>companyName/span>span classp>/span> span classo>/span> span classs>Test Merchant/span> span classn>var/span> span classn>billingaddress/span>span classo>:/span> span classp>/span>span classnf>String/span>span classp>:/span>span classn>Any/span>span classp>/span> span classo>/span> span classp>/span>span classo>:/span>span classp>/span> span classn>billingaddress/span>span classp>/span>span classs>address1/span>span classp>/span> span classo>/span> span classs>1060 West Addison/span> span classn>billingaddress/span>span classp>/span>span classs>city/span>span classp>/span> span classo>/span> span classs>Chicago/span> span classn>billingaddress/span>span classp>/span>span classs>stateOrProvince/span>span classp>/span> span classo>/span> span classs>IL/span> span classn>billingaddress/span>span classp>/span>span classs>postalCode/span>span classp>/span> span classo>/span> span classs>60613/span> span classn>request/span>span classp>/span>span classs>billingAddress/span>span classp>/span> span classo>/span> span classn>billingaddress/span> span classp>/span>span classn>client/span> span classnf>updateMerchantWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>merchantId/span>span classp>/span> span classo>/span> span classs><MERCHANT ID>/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classkc>true/span> span classn>request/span>span classp>/span>span classs>dbaName/span>span classp>/span> span classo>/span> span classs>Test Merchant/span> span classn>request/span>span classp>/span>span classs>companyName/span>span classp>/span> span classo>/span> span classs>Test Merchant/span> span classk>var/span> span classnv>billingaddress/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>billingaddress/span>span classp>/span>span classs>address1/span>span classp>/span> span classo>/span> span classs>1060 West Addison/span> span classn>billingaddress/span>span classp>/span>span classs>city/span>span classp>/span> span classo>/span> span classs>Chicago/span> span classn>billingaddress/span>span classp>/span>span classs>stateOrProvince/span>span classp>/span> span classo>/span> span classs>IL/span> span classn>billingaddress/span>span classp>/span>span classs>postalCode/span>span classp>/span> span classo>/span> span classs>60613/span> span classn>request/span>span classp>/span>span classs>billingAddress/span>span classp>/span> span classo>/span> span classn>billingaddress/span> span classn>client/span>span classo>./span>span classnf>updateMerchant/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>update_merchant_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>MerchantProfile/span>span classp>{/span> span classn>merchant_id/span>span classp>:/span> span classs><MERCHANT ID>/span>span classnf>.to_string/span>span classp>(),/span> span classn>test/span>span classp>:/span> span classk>true/span>span classp>,/span> span classn>dba_name/span>span classp>:/span> span classs>Test Merchant/span>span classnf>.to_string/span>span classp>(),/span> span classn>company_name/span>span classp>:/span> span classs>Test Merchant/span>span classnf>.to_string/span>span classp>(),/span> span classn>billing_address/span>span classp>:/span> span classnn>blockchyp/span>span classp>::/span>span classn>Address/span>span classp>{/span> span classn>address_1/span>span classp>:/span> span classs>1060 West Addison/span>span classnf>.to_string/span>span classp>(),/span> span classn>city/span>span classp>:/span> span classs>Chicago/span>span classnf>.to_string/span>span classp>(),/span> span classn>state_or_province/span>span classp>:/span> span classs>IL/span>span classnf>.to_string/span>span classp>(),/span> span classn>postal_code/span>span classp>:/span> span classs>60613/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>},/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.update_merchant/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>update_merchant_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>timeout/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>merchantId/span>span classp>:/span>span classw> /span>span classs2>J4XHM7G5DYI6ZHX4VTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>companyName/span>span classp>:/span>span classw> /span>span classs2>Test Merchant/span>span classp>,/span>span classw> /span>span classs2>dbaName/span>span classp>:/span>span classw> /span>span classs2>Test Merchant/span>span classp>,/span>span classw> /span>span classs2>contactName/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>contactNumber/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>locationName/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>storeNumber/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>partnerRef/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>timeZone/span>span classp>:/span>span classw> /span>span classs2>America/New_York/span>span classp>,/span>span classw> /span>span classs2>batchCloseTime/span>span classp>:/span>span classw> /span>span classs2>03:00/span>span classp>,/span>span classw> /span>span classs2>terminalUpdateTime/span>span classp>:/span>span classw> /span>span classs2>03:00/span>span classp>,/span>span classw> /span>span classs2>autoBatchClose/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>disableBatchEmails/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>pinEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>cashBackEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>storeAndForwardEnabled/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>partialAuthEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>splitBankAccountsEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>storeAndForwardFloorLimit/span>span classp>:/span>span classw> /span>span classs2>50.00/span>span classp>,/span>span classw> /span>span classs2>publicKey/span>span classp>:/span>span classw> /span>span classs2>13k85PDxfBpA6NwuZF8F4UDZ9RH8zf15iYnEoMgshz61g1zGPso/span>span classp>,/span>span classw> /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>active/span>span classp>,/span>span classw> /span>span classs2>cashDiscountEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>surveyTimeout/span>span classp>:/span>span classw> /span>span classmi>90/span>span classp>,/span>span classw> /span>span classs2>cooldownTimeout/span>span classp>:/span>span classw> /span>span classmi>30/span>span classp>,/span>span classw> /span>span classs2>tipEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>promptForTip/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>tipDefaults/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classs2>15%/span>span classp>,/span>span classw> /span>span classs2>20%/span>span classp>,/span>span classw> /span>span classs2>25%/span>span classw> /span>span classp>,/span>span classw> /span>span classs2>cashbackPresets/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classs2>1.00/span>span classp>,/span>span classw> /span>span classs2>10.00/span>span classp>,/span>span classw> /span>span classs2>20.00/span>span classp>,/span>span classw> /span>span classs2>50.00/span>span classw> /span>span classp>,/span>span classw> /span>span classs2>ebtEnabled/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>freeRangeRefundsEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>pinBypassEnabled/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>giftCardsDisabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>tcDisabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>digitalSignaturesEnabled/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>digitalSignatureReversal/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>billingAddress/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>address1/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>address2/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>city/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>stateOrProvince/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>postalCode/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>countryCode/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>latitude/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>longitude/span>span classp>:/span>span classw> /span>span classmi>0/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>shippingAddress/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>address1/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>address2/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>city/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>stateOrProvince/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>postalCode/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>countryCode/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>latitude/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>longitude/span>span classp>:/span>span classw> /span>span classmi>0/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>visa/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>masterCard/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>amex/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>discover/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>jcb/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>unionPay/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>contactlessEmv/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>manualEntryEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>manualEntryPromptZip/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>manualEntryPromptStreetNumber/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>gatewayOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>bankAccounts/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Merchant, Partner, & Organization/li>li>strong>Required Role:/strong> Merchant Management/li>/ul>p>This API can be used to update or create merchant accounts./p>p>Merchant scoped API credentials can be used to update merchant account settings./p>p>Partner scoped API credentials can be used to update merchants, create new test merchants or board new gateway merchants./p>p>strong>Merchant Descriptive Fields/strong>/p>p>The following fields are basic descriptive fields that can be used to describe and identify merchants./p>ul>li>strong>companyName:/strong> The merchant's official corporate entity name./li>li>strong>dbaName:/strong> The businesses DBA (doing business as) name./li>li>strong>contactName:/strong> Name of the merchant's primary control contact./li>li>strong>contactNumber:/strong> Primary control contact's phone number./li>li>strong>locationName:/strong> Optional location name for multi location operators./li>li>strong>storeNumber:/strong> Optional store number for multi location operators./li>li>strong>partnerRef:/strong> Optional reference number partners can add to a merchant record. Usually the partner's own identifier for the merchant./li>li>strong>timeZone:/strong> Unix style local time zone for the merchant. Example: America/New_York./li>li>strong>publicKey:/strong> Read only field. The merchant's blockchain public key. Generated and assigned when a merchant account is first created./li>li>strong>billingAddress:/strong> Address for billing and written correspondence./li>li>strong>shippingAddress:/strong> Physical shipping address. Usually the actual street address of the business./li>li>strong>status:/strong> Current status of the merchant account./li>li>strong>tcDisabled:/strong> Disables all terms and conditions features in the merchant dashboard. Used to hide the feature if a partner has not chosen to support it./li>li>strong>gatewayOnly:/strong> Indicates that a merchant has been boarded in gateway only mode. Not common./li>/ul>p>strong>Batch and Terminal Settings/strong>/p>p>The following fields are used to control batch closure and high level terminal configuration./p>ul>li>strong>batchCloseTime:/strong> Time in 24 hour HH:MM format when batches will automatically close in the merchant's local time. Defaults to 3 AM./li>li>strong>autoBatchClose:/strong> Flag the determines whether or not batches will automatically close. Defaults to true./li>li>strong>disableBatchEmails:/strong> Flag that optionally turns off automatic batch closure notification emails./li>li>strong>cooldownTimeout:/strong> The amount of time in seconds after a transactions for which the transaction response is displayed on the terminal. After the cooldown period elapses, the terminal will revert to the idle state and display the currently active terminal branding./li>li>strong>surveyTimeout:/strong> The amount of time in seconds a survey question should be displayed on a terminal before reverting to the idle screen./li>li>strong>pinEnabled:/strong> Enables pin code entry for debit cards, EBT cards, and EMV cards with pin CVMs. Will be ignored if terminals are not injected with the proper encryption keys./li>li>strong>pinBypassEnabled:/strong> Enable pin bypass for debit transactions./li>li>strong>cashBackEnabled:/strong> Enables cash back for debit transactions./li>li>strong>cashbackPresets:/strong> An array of four default values for cashback amounts when cashback is enabled./li>li>strong>storeAndForwardEnabled:/strong> Enables automatic store and forward during network outages. Store and Forward does not support cash back, refunds, EBT, or gift card transactions./li>li>strong>storeAndForwardFloorLimit:/strong> Maximum dollar value of a store and forward transaction./li>li>strong>ebtEnabled:/strong> Enables EBT (SNAP) on BlockChyp terminals./li>li>strong>tipEnabled:/strong> Enables tips entry on the terminal./li>li>strong>promptForTip:/strong> If true, the terminal will always prompt for a tip, even if the API call does not request a tip prompt./li>li>strong>tipDefaults:/strong> An array of exactly three percentages that will be used to calculate default tip amounts./li>li>strong>giftCardsDisabled:/strong> Disables BlockChyp gift cards. Normally only used if the merchant is using an alternate gift card system./li>li>strong>digitalSignaturesEnabled:/strong> Enables electronic signature capture for mag stripe cards and EMV cards with Signature CVMs./li>li>strong>digitalSignatureReversal:/strong> Will cause a transaction to auto-reverse if the consumer refuses to provide a signature./li>li>strong>manualEntryEnabled:/strong> Enables manual card entry./li>li>strong>manualEntryPromptZip:/strong> Requires zip code based address verification for manual card entry./li>li>strong>manualEntryPromptStreetNumber:/strong> Requires street/address based verification for manual card entry./li>/ul>p>strong>Card Brand and Transaction Settings/strong>/p>ul>li>strong>freeRangeRefundsEnabled:/strong> Enables direct refunds that do not reference a previous transaction./li>li>strong>partialAuthEnabled:/strong> Indicates that partial authorizations (usually for gift card support) are enabled./li>li>strong>splitBankAccountsEnabled:/strong> Used for law firm merchants only./li>li>strong>contactlessEmv:/strong> Enables contactless/tap transactions on a terminal. Defaults to true./li>li>strong>visa:/strong> Enables Visa transactions./li>li>strong>masterCard:/strong> Enables MasterCard transactions./li>li>strong>amex:/strong> Enables American Express transactions./li>li>strong>discover:/strong> Enables Discover transactions./li>li>strong>jcb:/strong> Enables JCB (Japan Card Bureau) transactions./li>li>strong>unionPay:/strong> Enables China UnionPay transactions./li>/ul>aside classwarning>As explained above, a number of merchant related fields are not modifiable for live merchantsunless the merchant has been boarded as a gateway only merchant. BlockChyp only boards merchants in gateway only mode in very rare circumstances for high risk MCC codes./aside>h2 idmerchant-users>Merchant Users/h2>blockquote>p>Merchant Users Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>merchant-users/span> -merchantIdspan classo>/span>span classs2><MERCHANT ID>/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>merchant-users/span> -merchantIdspan classo>/span>span classs2><MERCHANT ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>merchantUsersExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>MerchantProfileRequest/span>span classp>{/span>span classx> /span>span classn>MerchantID/span>span classo>:/span>span classx> /span>span classs><MERCHANT ID>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>MerchantUsers/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>MerchantProfileRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>MerchantProfileRequest/span>span classp>{/span> span classn>MerchantId/span> span classp>/span> span classs><MERCHANT ID>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>MerchantUsersResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>MerchantUsersAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.MerchantProfileRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.MerchantUsersResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>MerchantUsersExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>MerchantProfileRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>MerchantProfileRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setMerchantId/span>span classo>(/span>span classs><MERCHANT ID>/span>span classo>);/span> span classc1>// Send the request/span> span classn>MerchantUsersResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>merchantUsers/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>merchantId/span> span classo>>/span> span classs1><MERCHANT ID>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>merchantUsers/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>merchantId: /span>span classs1><MERCHANT ID>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>merchantUsers/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>merchantId/span>span classp>:/span> span classs><MERCHANT ID>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>merchant_users/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>merchantUsers/span>span classp>({/span> span classna>merchantId/span>span classp>:/span> span classs1><MERCHANT ID>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>MerchantProfileRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>merchantId/span> span classo>/span> span classs1><MERCHANT ID>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>merchantUsers/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>MerchantUsersResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>merchantId/span>span classp>/span> span classo>/span> span classs><MERCHANT ID>/span> span classp>/span>span classn>client/span> span classnf>merchantUsersWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>merchantId/span>span classp>/span> span classo>/span> span classs><MERCHANT ID>/span> span classn>client/span>span classo>./span>span classnf>merchantUsers/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>merchant_users_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>MerchantProfileRequest/span>span classp>{/span> span classn>merchant_id/span>span classp>:/span> span classs><MERCHANT ID>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.merchant_users/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>merchant_users_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>results/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>WY2ZBQWRFEI6ZE6GVTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>firstName/span>span classp>:/span>span classw> /span>span classs2>Aaron/span>span classp>,/span>span classw> /span>span classs2>lastName/span>span classp>:/span>span classw> /span>span classs2>Anderson/span>span classp>,/span>span classw> /span>span classs2>email/span>span classp>:/span>span classw> /span>span classs2>doublea@drinkhomicide.com/span>span classp>,/span>span classw> /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>Active/span>span classp>,/span>span classw> /span>span classs2>type/span>span classp>:/span>span classw> /span>span classs2>user/span>span classp>,/span>span classw> /span>span classs2>roles/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classs2>STDPARTNER/span>span classw> /span>span classp>,/span>span classw> /span>span classs2>locked/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Partner & Organization/li>li>strong>Required Role:/strong> Merchant Management/li>/ul>p>This API returns all users and pending invites associated with a merchant account including any assigned role codes./p>h2 idinvite-merchant-user>Invite Merchant User/h2>blockquote>p>Invite Merchant User Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>invite-merchant-user/span> -emailspan classo>/span>span classs2>elon@twitter.com/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>invite-merchant-user/span> -emailspan classo>/span>span classs2>elon@twitter.com/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>inviteMerchantUserExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>InviteMerchantUserRequest/span>span classp>{/span>span classx> /span>span classn>Email/span>span classo>:/span>span classx> /span>span classs>Email address for the invite/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>InviteMerchantUser/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>InviteMerchantUserRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>InviteMerchantUserRequest/span>span classp>{/span> span classn>Email/span> span classp>/span> span classs>Email address for the invite/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>Acknowledgement/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>InviteMerchantUserAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.InviteMerchantUserRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.Acknowledgement/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>InviteMerchantUserExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>InviteMerchantUserRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>InviteMerchantUserRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setEmail/span>span classo>(/span>span classs>Email address for the invite/span>span classo>);/span> span classc1>// Send the request/span> span classn>Acknowledgement/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>inviteMerchantUser/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>email/span> span classo>>/span> span classs1>Email address for the invite/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>inviteMerchantUser/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>email: /span>span classs1>Email address for the invite/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>inviteMerchantUser/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>email/span>span classp>:/span> span classs>Email address for the invite/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>invite_merchant_user/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>inviteMerchantUser/span>span classp>({/span> span classna>email/span>span classp>:/span> span classs1>Email address for the invite/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>InviteMerchantUserRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>email/span> span classo>/span> span classs1>Email address for the invite/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>inviteMerchantUser/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>Acknowledgement/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>email/span>span classp>/span> span classo>/span> span classs>Email address for the invite/span> span classp>/span>span classn>client/span> span classnf>inviteMerchantUserWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>email/span>span classp>/span> span classo>/span> span classs>Email address for the invite/span> span classn>client/span>span classo>./span>span classnf>inviteMerchantUser/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>invite_merchant_user_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>InviteMerchantUserRequest/span>span classp>{/span> span classn>email/span>span classp>:/span> span classs>Email address for the invite/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.invite_merchant_user/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>invite_merchant_user_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Partner & Organization/li>li>strong>Required Role:/strong> Merchant Management/li>/ul>p>Invites a new user to join a merchant account. code>email/code>, code>firstName/code>, and code>lastName/code> are required./p>p>The user will be sent an invite email with steps for creating a BlockChyp account and linking it toa merchant account. If the user already has a BlockChyp user account, the new user signup wil be skippedand the existing user account will be linked to the merchant account./p>p>Developers can optionally restrict the user's access level by sending one or more role codes.Otherwise, the user will be given the default merchant user role. (STDMERCHANT)/p>h2 idadd-gateway-merchant>Add Gateway Merchant/h2>blockquote>p>Add Gateway Merchant Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>add-gateway-merchant/span> -dbaNamespan classo>/span>span classs2>Gateway Merchant/span> -companyNamespan classo>/span>span classs2>Gateway Merchant/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>add-gateway-merchant/span> -dbaNamespan classo>/span>span classs2>Gateway Merchant/span> -companyNamespan classo>/span>span classs2>Gateway Merchant/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>addGatewayMerchantExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>AddGatewayMerchantRequest/span>span classp>{/span>span classx> /span>span classn>Profile/span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>MerchantProfile/span>span classp>{/span>span classx> /span>span classn>DBAName/span>span classo>:/span>span classx> /span>span classs>DBA Name/span>span classp>,/span>span classx> /span>span classn>CompanyName/span>span classo>:/span>span classx> /span>span classs>Corporate Entity Name/span>span classp>,/span>span classx> /span>span classp>},/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>AddGatewayMerchant/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>AddGatewayMerchantRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>AddGatewayMerchantRequest/span>span classp>{/span> span classn>Profile/span> span classp>/span> span classk>new/span> span classn>MerchantProfile/span> span classp>{/span> span classn>DbaName/span> span classp>/span> span classs>DBA Name/span>span classp>,/span> span classn>CompanyName/span> span classp>/span> span classs>Corporate Entity Name/span>span classp>,/span> span classp>},/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>MerchantProfileResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>AddGatewayMerchantAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.AddGatewayMerchantRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.MerchantProfileResponse/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.MerchantProfile/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>AddGatewayMerchantExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>AddGatewayMerchantRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>AddGatewayMerchantRequest/span>span classo>();/span> span classn>MerchantProfile/span> span classn>profile/span> span classo>/span> span classk>new/span> span classn>MerchantProfile/span>span classo>();/span> span classn>profile/span>span classo>./span>span classna>setDbaName/span>span classo>(/span>span classs>DBA Name/span>span classo>);/span> span classn>profile/span>span classo>./span>span classna>setCompanyName/span>span classo>(/span>span classs>Corporate Entity Name/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setProfile/span>span classo>(/span>span classn>profile/span>span classo>);/span> span classc1>// Send the request/span> span classn>MerchantProfileResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>addGatewayMerchant/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>profile/span> span classo>>/span> span classp>/span> span classs1>dbaName/span> span classo>>/span> span classs1>DBA Name/span>span classp>,/span> span classs1>companyName/span> span classo>>/span> span classs1>Corporate Entity Name/span>span classp>,/span> span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>addGatewayMerchant/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>profile: /span>span classp>{/span> span classss>dbaName: /span>span classs1>DBA Name/span>span classp>,/span> span classss>companyName: /span>span classs1>Corporate Entity Name/span> span classp>}/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>addGatewayMerchant/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>profile/span>span classp>:/span> span classp>{/span> span classs>dbaName/span>span classp>:/span> span classs>DBA Name/span>span classp>,/span> span classs>companyName/span>span classp>:/span> span classs>Corporate Entity Name/span>span classp>,/span> span classp>},/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>add_gateway_merchant/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>addGatewayMerchant/span>span classp>({/span> span classna>profile/span>span classp>:/span> span classp>{/span> span classna>dbaName/span>span classp>:/span> span classs1>DBA Name/span>span classp>,/span> span classna>companyName/span>span classp>:/span> span classs1>Corporate Entity Name/span>span classp>,/span> span classp>},/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>AddGatewayMerchantRequest/span>span classp>();/span>span classkd>const/span> span classnx>profile/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>MerchantProfile/span>span classp>();/span>span classnx>profile/span>span classp>./span>span classnx>dbaName/span> span classo>/span> span classs1>DBA Name/span>span classp>;/span>span classnx>profile/span>span classp>./span>span classnx>companyName/span> span classo>/span> span classs1>Corporate Entity Name/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>profile/span> span classo>/span> span classnx>profile/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>addGatewayMerchant/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>MerchantProfileResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>var/span> span classn>profile/span>span classo>:/span> span classp>/span>span classnf>String/span>span classp>:/span>span classn>Any/span>span classp>/span> span classo>/span> span classp>/span>span classo>:/span>span classp>/span> span classn>profile/span>span classp>/span>span classs>dbaName/span>span classp>/span> span classo>/span> span classs>DBA Name/span> span classn>profile/span>span classp>/span>span classs>companyName/span>span classp>/span> span classo>/span> span classs>Corporate Entity Name/span> span classn>request/span>span classp>/span>span classs>profile/span>span classp>/span> span classo>/span> span classn>profile/span> span classp>/span>span classn>client/span> span classnf>addGatewayMerchantWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classk>var/span> span classnv>profile/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>profile/span>span classp>/span>span classs>dbaName/span>span classp>/span> span classo>/span> span classs>DBA Name/span> span classn>profile/span>span classp>/span>span classs>companyName/span>span classp>/span> span classo>/span> span classs>Corporate Entity Name/span> span classn>request/span>span classp>/span>span classs>profile/span>span classp>/span> span classo>/span> span classn>profile/span> span classn>client/span>span classo>./span>span classnf>addGatewayMerchant/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>add_gateway_merchant_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>AddGatewayMerchantRequest/span>span classp>{/span> span classn>profile/span>span classp>:/span> span classnn>blockchyp/span>span classp>::/span>span classn>MerchantProfile/span>span classp>{/span> span classn>dba_name/span>span classp>:/span> span classs>DBA Name/span>span classnf>.to_string/span>span classp>(),/span> span classn>company_name/span>span classp>:/span> span classs>Corporate Entity Name/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>},/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.add_gateway_merchant/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>add_gateway_merchant_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>timeout/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>merchantId/span>span classp>:/span>span classw> /span>span classs2>J4XHM7G5DYI6ZHX4VTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>companyName/span>span classp>:/span>span classw> /span>span classs2>Test Merchant/span>span classp>,/span>span classw> /span>span classs2>dbaName/span>span classp>:/span>span classw> /span>span classs2>Test Merchant/span>span classp>,/span>span classw> /span>span classs2>contactName/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>contactNumber/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>locationName/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>storeNumber/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>partnerRef/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>timeZone/span>span classp>:/span>span classw> /span>span classs2>America/New_York/span>span classp>,/span>span classw> /span>span classs2>batchCloseTime/span>span classp>:/span>span classw> /span>span classs2>03:00/span>span classp>,/span>span classw> /span>span classs2>terminalUpdateTime/span>span classp>:/span>span classw> /span>span classs2>03:00/span>span classp>,/span>span classw> /span>span classs2>autoBatchClose/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>disableBatchEmails/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>pinEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>cashBackEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>storeAndForwardEnabled/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>partialAuthEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>splitBankAccountsEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>storeAndForwardFloorLimit/span>span classp>:/span>span classw> /span>span classs2>50.00/span>span classp>,/span>span classw> /span>span classs2>publicKey/span>span classp>:/span>span classw> /span>span classs2>13k85PDxfBpA6NwuZF8F4UDZ9RH8zf15iYnEoMgshz61g1zGPso/span>span classp>,/span>span classw> /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>active/span>span classp>,/span>span classw> /span>span classs2>cashDiscountEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>surveyTimeout/span>span classp>:/span>span classw> /span>span classmi>90/span>span classp>,/span>span classw> /span>span classs2>cooldownTimeout/span>span classp>:/span>span classw> /span>span classmi>30/span>span classp>,/span>span classw> /span>span classs2>tipEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>promptForTip/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>tipDefaults/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classs2>15%/span>span classp>,/span>span classw> /span>span classs2>20%/span>span classp>,/span>span classw> /span>span classs2>25%/span>span classw> /span>span classp>,/span>span classw> /span>span classs2>cashbackPresets/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classs2>1.00/span>span classp>,/span>span classw> /span>span classs2>10.00/span>span classp>,/span>span classw> /span>span classs2>20.00/span>span classp>,/span>span classw> /span>span classs2>50.00/span>span classw> /span>span classp>,/span>span classw> /span>span classs2>ebtEnabled/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>freeRangeRefundsEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>pinBypassEnabled/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>giftCardsDisabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>tcDisabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>digitalSignaturesEnabled/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>digitalSignatureReversal/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>billingAddress/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>address1/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>address2/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>city/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>stateOrProvince/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>postalCode/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>countryCode/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>latitude/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>longitude/span>span classp>:/span>span classw> /span>span classmi>0/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>shippingAddress/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>address1/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>address2/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>city/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>stateOrProvince/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>postalCode/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>countryCode/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>latitude/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>longitude/span>span classp>:/span>span classw> /span>span classmi>0/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>visa/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>masterCard/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>amex/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>discover/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>jcb/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>unionPay/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>contactlessEmv/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>manualEntryEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>manualEntryPromptZip/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>manualEntryPromptStreetNumber/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>gatewayOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>bankAccounts/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Partner/li>li>strong>Required Role:/strong> Gateway Boarding/li>/ul>p>This is a partner level API that can be used to manually board gateway merchants. Use this API in conjunctionwith Platform Configuration to instantly board gateway merchants. Note that most partners don't have permission to do this and are unlikely to get it./p>p>Settings can be changed by using the Update Merchant API./p>h2 idadd-test-merchant>Add Test Merchant/h2>blockquote>p>Add Test Merchant Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>add-test-merchant/span> -dbaNamespan classo>/span>span classs2>Test Merchant/span> -companyNamespan classo>/span>span classs2>Test Merchant/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>add-test-merchant/span> -dbaNamespan classo>/span>span classs2>Test Merchant/span> -companyNamespan classo>/span>span classs2>Test Merchant/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>addTestMerchantExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>AddTestMerchantRequest/span>span classp>{/span>span classx> /span>span classn>DBAName/span>span classo>:/span>span classx> /span>span classs>DBA Name/span>span classp>,/span>span classx> /span>span classn>CompanyName/span>span classo>:/span>span classx> /span>span classs>Corporate Entity Name/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>AddTestMerchant/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>AddTestMerchantRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>AddTestMerchantRequest/span>span classp>{/span> span classn>DbaName/span> span classp>/span> span classs>DBA Name/span>span classp>,/span> span classn>CompanyName/span> span classp>/span> span classs>Corporate Entity Name/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>MerchantProfileResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>AddTestMerchantAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.AddTestMerchantRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.MerchantProfileResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>AddTestMerchantExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>AddTestMerchantRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>AddTestMerchantRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setDbaName/span>span classo>(/span>span classs>DBA Name/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setCompanyName/span>span classo>(/span>span classs>Corporate Entity Name/span>span classo>);/span> span classc1>// Send the request/span> span classn>MerchantProfileResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>addTestMerchant/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>dbaName/span> span classo>>/span> span classs1>DBA Name/span>span classp>,/span> span classs1>companyName/span> span classo>>/span> span classs1>Corporate Entity Name/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>addTestMerchant/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>dbaName: /span>span classs1>DBA Name/span>span classp>,/span> span classss>companyName: /span>span classs1>Corporate Entity Name/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>addTestMerchant/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>dbaName/span>span classp>:/span> span classs>DBA Name/span>span classp>,/span> span classs>companyName/span>span classp>:/span> span classs>Corporate Entity Name/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>add_test_merchant/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>addTestMerchant/span>span classp>({/span> span classna>dbaName/span>span classp>:/span> span classs1>DBA Name/span>span classp>,/span> span classna>companyName/span>span classp>:/span> span classs1>Corporate Entity Name/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>AddTestMerchantRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>dbaName/span> span classo>/span> span classs1>DBA Name/span>span classp>;/span>span classnx>request/span>span classp>./span>span classnx>companyName/span> span classo>/span> span classs1>Corporate Entity Name/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>addTestMerchant/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>MerchantProfileResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>dbaName/span>span classp>/span> span classo>/span> span classs>DBA Name/span> span classn>request/span>span classp>/span>span classs>companyName/span>span classp>/span> span classo>/span> span classs>Corporate Entity Name/span> span classp>/span>span classn>client/span> span classnf>addTestMerchantWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>dbaName/span>span classp>/span> span classo>/span> span classs>DBA Name/span> span classn>request/span>span classp>/span>span classs>companyName/span>span classp>/span> span classo>/span> span classs>Corporate Entity Name/span> span classn>client/span>span classo>./span>span classnf>addTestMerchant/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>add_test_merchant_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>AddTestMerchantRequest/span>span classp>{/span> span classn>dba_name/span>span classp>:/span> span classs>DBA Name/span>span classnf>.to_string/span>span classp>(),/span> span classn>company_name/span>span classp>:/span> span classs>Corporate Entity Name/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.add_test_merchant/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>add_test_merchant_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>timeout/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>merchantId/span>span classp>:/span>span classw> /span>span classs2>J4XHM7G5DYI6ZHX4VTPEQAAREI/span>span classp>,/span>span classw> /span>span classs2>companyName/span>span classp>:/span>span classw> /span>span classs2>Test Merchant/span>span classp>,/span>span classw> /span>span classs2>dbaName/span>span classp>:/span>span classw> /span>span classs2>Test Merchant/span>span classp>,/span>span classw> /span>span classs2>contactName/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>contactNumber/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>locationName/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>storeNumber/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>partnerRef/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>timeZone/span>span classp>:/span>span classw> /span>span classs2>America/New_York/span>span classp>,/span>span classw> /span>span classs2>batchCloseTime/span>span classp>:/span>span classw> /span>span classs2>03:00/span>span classp>,/span>span classw> /span>span classs2>terminalUpdateTime/span>span classp>:/span>span classw> /span>span classs2>03:00/span>span classp>,/span>span classw> /span>span classs2>autoBatchClose/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>disableBatchEmails/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>pinEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>cashBackEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>storeAndForwardEnabled/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>partialAuthEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>splitBankAccountsEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>storeAndForwardFloorLimit/span>span classp>:/span>span classw> /span>span classs2>50.00/span>span classp>,/span>span classw> /span>span classs2>publicKey/span>span classp>:/span>span classw> /span>span classs2>13k85PDxfBpA6NwuZF8F4UDZ9RH8zf15iYnEoMgshz61g1zGPso/span>span classp>,/span>span classw> /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>active/span>span classp>,/span>span classw> /span>span classs2>cashDiscountEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>surveyTimeout/span>span classp>:/span>span classw> /span>span classmi>90/span>span classp>,/span>span classw> /span>span classs2>cooldownTimeout/span>span classp>:/span>span classw> /span>span classmi>30/span>span classp>,/span>span classw> /span>span classs2>tipEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>promptForTip/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>tipDefaults/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classs2>15%/span>span classp>,/span>span classw> /span>span classs2>20%/span>span classp>,/span>span classw> /span>span classs2>25%/span>span classw> /span>span classp>,/span>span classw> /span>span classs2>cashbackPresets/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classs2>1.00/span>span classp>,/span>span classw> /span>span classs2>10.00/span>span classp>,/span>span classw> /span>span classs2>20.00/span>span classp>,/span>span classw> /span>span classs2>50.00/span>span classw> /span>span classp>,/span>span classw> /span>span classs2>ebtEnabled/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>freeRangeRefundsEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>pinBypassEnabled/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>giftCardsDisabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>tcDisabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>digitalSignaturesEnabled/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>digitalSignatureReversal/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>billingAddress/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>address1/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>address2/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>city/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>stateOrProvince/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>postalCode/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>countryCode/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>latitude/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>longitude/span>span classp>:/span>span classw> /span>span classmi>0/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>shippingAddress/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>address1/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>address2/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>city/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>stateOrProvince/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>postalCode/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>countryCode/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>latitude/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>longitude/span>span classp>:/span>span classw> /span>span classmi>0/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>visa/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>masterCard/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>amex/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>discover/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>jcb/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>unionPay/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>contactlessEmv/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>manualEntryEnabled/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>manualEntryPromptZip/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>manualEntryPromptStreetNumber/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>gatewayOnly/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>bankAccounts/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Partner/li>li>strong>Required Role:/strong> Merchant Management/li>/ul>p>This is a partner level API that can be used to create test merchant accounts. This createsa basic test merchant with default settings./p>p>Settings can be changed by using the Update Merchant API./p>h2 iddelete-test-merchant>Delete Test Merchant/h2>blockquote>p>Delete Test Merchant Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -cmdspan classo>/span>span classs2>delete-test-merchant/span> -merchantIdspan classo>/span>span classs2><MERCHANT ID>/span>Windows: ./blockchyp.exe -cmdspan classo>/span>span classs2>delete-test-merchant/span> -merchantIdspan classo>/span>span classs2><MERCHANT ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>deleteTestMerchantExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>MerchantProfileRequest/span>span classp>{/span>span classx> /span>span classn>MerchantID/span>span classo>:/span>span classx> /span>span classs><MERCHANT ID>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>DeleteTestMerchant/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>MerchantProfileRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>MerchantProfileRequest/span>span classp>{/span> span classn>MerchantId/span> span classp>/span> span classs><MERCHANT ID>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>Acknowledgement/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>DeleteTestMerchantAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.MerchantProfileRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.Acknowledgement/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>DeleteTestMerchantExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>MerchantProfileRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>MerchantProfileRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setMerchantId/span>span classo>(/span>span classs><MERCHANT ID>/span>span classo>);/span> span classc1>// Send the request/span> span classn>Acknowledgement/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>deleteTestMerchant/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>merchantId/span> span classo>>/span> span classs1><MERCHANT ID>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>deleteTestMerchant/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>merchantId: /span>span classs1><MERCHANT ID>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>deleteTestMerchant/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>merchantId/span>span classp>:/span> span classs><MERCHANT ID>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>delete_test_merchant/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>deleteTestMerchant/span>span classp>({/span> span classna>merchantId/span>span classp>:/span> span classs1><MERCHANT ID>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>MerchantProfileRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>merchantId/span> span classo>/span> span classs1><MERCHANT ID>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>deleteTestMerchant/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>Acknowledgement/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>merchantId/span>span classp>/span> span classo>/span> span classs><MERCHANT ID>/span> span classp>/span>span classn>client/span> span classnf>deleteTestMerchantWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>merchantId/span>span classp>/span> span classo>/span> span classs><MERCHANT ID>/span> span classn>client/span>span classo>./span>span classnf>deleteTestMerchant/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>delete_test_merchant_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>MerchantProfileRequest/span>span classp>{/span> span classn>merchant_id/span>span classp>:/span> span classs><MERCHANT ID>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.delete_test_merchant/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>delete_test_merchant_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Partner/li>li>strong>Required Role:/strong> Merchant Management/li>/ul>p>This partner API can be used to delete unused test merchant accounts. code>merchantId/code> is a required parameter./p>h1 idpartner-api>Partner API/h1>p>These partner only APIs give ISV partners advanced reporting and tools for managing their portfolio./p>p>Most of the APIs below are for portfolio reporting and range from basic partner commission statementsto individual statements with all underlying card brand data./p>p>We also provide a pricing policy API that enables partners to pull down the current pricing rulesin force for any merchant in their portfolio./p>aside classinfo>b>Currency Data/b>p>All partner APIs return currency and percentage values in two formats: floating point and formatted strings./p>p>Its recommended that all developers use the formatted string as this will ensure the most precise values.Floating point numbers are usually not appropriate for currency or fixed point decimal numbers asthe underlying binary encoding can lead to errors in precision. We provide floating point valuesonly as a convenience for developers want to save development time and can live with approximatedvalues in their use case./p>/aside>h2 idretrieve-pricing-policy>Retrieve Pricing Policy/h2>blockquote>p>Retrieve Pricing Policy Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>pricing-policy/span> -merchantIdspan classo>/span>span classs2><ID>/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>pricing-policy/span> -merchantIdspan classo>/span>span classs2><ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>pricingPolicyExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>PricingPolicyRequest/span>span classp>{}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>PricingPolicy/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>PricingPolicyRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>PricingPolicyRequest/span>span classp>{/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>PricingPolicyResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>PricingPolicyAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.PricingPolicyRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.PricingPolicyResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>PricingPolicyExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>PricingPolicyRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>PricingPolicyRequest/span>span classo>();/span> span classc1>// Send the request/span> span classn>PricingPolicyResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>pricingPolicy/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>pricingPolicy/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>pricingPolicy/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>pricing_policy/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>pricingPolicy/span>span classp>({/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>PricingPolicyRequest/span>span classp>();/span>span classnx>client/span>span classp>./span>span classnx>pricingPolicy/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>PricingPolicyResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classp>/span>span classn>client/span> span classnf>pricingPolicyWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>client/span>span classo>./span>span classnf>pricingPolicy/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>pricing_policy_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>PricingPolicyRequest/span>span classp>{/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.pricing_policy/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>pricing_policy_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>W5JCGFVVXAI6ZE6K700KYEIAAI/span>span classp>,/span>span classw> /span>span classs2>partnerId/span>span classp>:/span>span classw> /span>span classs2>Y5F3U5NQMII6ZBSUA700YEIAAU/span>span classp>,/span>span classw> /span>span classs2>merchantId/span>span classp>:/span>span classw> /span>span classs2>W5JC7000VXAI6ZE6KAJBKYEIAAI/span>span classp>,/span>span classw> /span>span classs2>enabled/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classs2>2022-04-06T17:17:29Z/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Credit: 5 cents + 10 pts Debit:/span>span classp>,/span>span classw> /span>span classs2>policyType/span>span classp>:/span>span classw> /span>span classs2>interchange/span>span classp>,/span>span classw> /span>span classs2>partnerMarkupSplit/span>span classp>:/span>span classw> /span>span classs2>25%/span>span classp>,/span>span classw> /span>span classs2>standardFlatRate/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>buyRate/span>span classp>:/span>span classw> /span>span classs2>0.015%/span>span classp>,/span>span classw> /span>span classs2>current/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>limit/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>debitFlatRate/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>buyRate/span>span classp>:/span>span classw> /span>span classs2>0.015%/span>span classp>,/span>span classw> /span>span classs2>current/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>limit/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>ecommerceFlatRate/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>buyRate/span>span classp>:/span>span classw> /span>span classs2>0.015%/span>span classp>,/span>span classw> /span>span classs2>current/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>limit/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>keyedFlatRate/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>buyRate/span>span classp>:/span>span classw> /span>span classs2>0.015%/span>span classp>,/span>span classw> /span>span classs2>current/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>limit/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>premiumFlatRate/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>buyRate/span>span classp>:/span>span classw> /span>span classs2>0.12%/span>span classp>,/span>span classw> /span>span classs2>current/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>limit/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>standardInterchangeMarkup/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>buyRate/span>span classp>:/span>span classw> /span>span classs2>0.015%/span>span classp>,/span>span classw> /span>span classs2>current/span>span classp>:/span>span classw> /span>span classs2>0.1%/span>span classp>,/span>span classw> /span>span classs2>limit/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>debitInterchangeMarkup/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>buyRate/span>span classp>:/span>span classw> /span>span classs2>0.015%/span>span classp>,/span>span classw> /span>span classs2>current/span>span classp>:/span>span classw> /span>span classs2>0.1%/span>span classp>,/span>span classw> /span>span classs2>limit/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>ecommerceInterchangeMarkup/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>buyRate/span>span classp>:/span>span classw> /span>span classs2>0.02%/span>span classp>,/span>span classw> /span>span classs2>current/span>span classp>:/span>span classw> /span>span classs2>0.1%/span>span classp>,/span>span classw> /span>span classs2>limit/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>keyedInterchangeMarkup/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>buyRate/span>span classp>:/span>span classw> /span>span classs2>0.02%/span>span classp>,/span>span classw> /span>span classs2>current/span>span classp>:/span>span classw> /span>span classs2>0.1%/span>span classp>,/span>span classw> /span>span classs2>limit/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>premiumInterchangeMarkup/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>buyRate/span>span classp>:/span>span classw> /span>span classs2>0.12%/span>span classp>,/span>span classw> /span>span classs2>current/span>span classp>:/span>span classw> /span>span classs2>0.2%/span>span classp>,/span>span classw> /span>span classs2>limit/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>standardTransactionFee/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>buyRate/span>span classp>:/span>span classw> /span>span classs2>0.02/span>span classp>,/span>span classw> /span>span classs2>current/span>span classp>:/span>span classw> /span>span classs2>0.05/span>span classp>,/span>span classw> /span>span classs2>limit/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>debitTransactionFee/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>buyRate/span>span classp>:/span>span classw> /span>span classs2>0.02/span>span classp>,/span>span classw> /span>span classs2>current/span>span classp>:/span>span classw> /span>span classs2>0.05/span>span classp>,/span>span classw> /span>span classs2>limit/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>ecommerceTransactionFee/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>buyRate/span>span classp>:/span>span classw> /span>span classs2>0.02/span>span classp>,/span>span classw> /span>span classs2>current/span>span classp>:/span>span classw> /span>span classs2>0.05/span>span classp>,/span>span classw> /span>span classs2>limit/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>keyedTransactionFee/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>buyRate/span>span classp>:/span>span classw> /span>span classs2>0.02/span>span classp>,/span>span classw> /span>span classs2>current/span>span classp>:/span>span classw> /span>span classs2>0.05/span>span classp>,/span>span classw> /span>span classs2>limit/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>premiumTransactionFee/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>buyRate/span>span classp>:/span>span classw> /span>span classs2>0.07/span>span classp>,/span>span classw> /span>span classs2>current/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>limit/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>ebtTransactionFee/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>buyRate/span>span classp>:/span>span classw> /span>span classs2>0.065/span>span classp>,/span>span classw> /span>span classs2>current/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>limit/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>monthlyFee/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>buyRate/span>span classp>:/span>span classw> /span>span classs2>5.00/span>span classp>,/span>span classw> /span>span classs2>current/span>span classp>:/span>span classw> /span>span classs2>10.00/span>span classp>,/span>span classw> /span>span classs2>limit/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>annualFee/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>buyRate/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>current/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>limit/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>chargebackFee/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>buyRate/span>span classp>:/span>span classw> /span>span classs2>12.00/span>span classp>,/span>span classw> /span>span classs2>current/span>span classp>:/span>span classw> /span>span classs2>20.00/span>span classp>,/span>span classw> /span>span classs2>limit/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>avsFee/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>buyRate/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>current/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>limit/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>batchFee/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>buyRate/span>span classp>:/span>span classw> /span>span classs2>0.07/span>span classp>,/span>span classw> /span>span classs2>current/span>span classp>:/span>span classw> /span>span classs2>0.08/span>span classp>,/span>span classw> /span>span classs2>limit/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>voiceAuthFee/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>buyRate/span>span classp>:/span>span classw> /span>span classs2>0.75/span>span classp>,/span>span classw> /span>span classs2>current/span>span classp>:/span>span classw> /span>span classs2>1.00/span>span classp>,/span>span classw> /span>span classs2>limit/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>accountSetupFee/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>buyRate/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>current/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>limit/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Partner/li>li>strong>Required Role:/strong> Partner API Access/li>/ul>p>The API returns the current pricing policy for a merchant. This API is valid for partner scoped API credentialsand code>merchantId/code> is a required parameter. By default this API returns the currently in-force pricing policy for a merchant,but other inactive policies can be returned by providing the code>id/code> parameter./p>p>Buy rates for interchange plus and fixed rate pricing are always returned, but only the pricing related to the pricing model type (flat rate or interchange plus) are actually used in fee calculation./p>p>Each pricing level returns three values: code>buyRate/code>, code>current/code>, and code>limit/code>. The actual price the merchant will pay is given in the code>current/code> field. The other values reflect the contract minimum (code>buyRate/code>) and maximum (code>limit/code>) rangethe partner can use when changing prices./p>h2 idpartner-statements>Partner Statements/h2>blockquote>p>Partner Statements Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>partner-statements/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>partner-statements/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>partnerStatementsExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>PartnerStatementListRequest/span>span classp>{}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>PartnerStatements/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>PartnerStatementListRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>PartnerStatementListRequest/span>span classp>{/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>PartnerStatementListResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>PartnerStatementsAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.PartnerStatementListRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.PartnerStatementListResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>PartnerStatementsExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>PartnerStatementListRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>PartnerStatementListRequest/span>span classo>();/span> span classc1>// Send the request/span> span classn>PartnerStatementListResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>partnerStatements/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>partnerStatements/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>partnerStatements/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>partner_statements/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>partnerStatements/span>span classp>({/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>PartnerStatementListRequest/span>span classp>();/span>span classnx>client/span>span classp>./span>span classnx>partnerStatements/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>PartnerStatementListResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classp>/span>span classn>client/span> span classnf>partnerStatementsWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>client/span>span classo>./span>span classnf>partnerStatements/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>partner_statements_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>PartnerStatementListRequest/span>span classp>{/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.partner_statements/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>partner_statements_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>statements/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SCH34K3JAEI65EJNAJBKYEIAAI/span>span classp>,/span>span classw> /span>span classs2>statementDate/span>span classp>:/span>span classw> /span>span classs2>2023-10-23T20:14:06Z/span>span classp>,/span>span classw> /span>span classs2>totalVolume/span>span classp>:/span>span classw> /span>span classmf>548483.05/span>span classp>,/span>span classw> /span>span classs2>totalVolumeFormatted/span>span classp>:/span>span classw> /span>span classs2>548,483.05/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>12175/span>span classp>,/span>span classw> /span>span classs2>partnerCommission/span>span classp>:/span>span classw> /span>span classmf>395.15/span>span classp>,/span>span classw> /span>span classs2>partnerCommissionFormatted/span>span classp>:/span>span classw> /span>span classs2>395.15/span>span classp>,/span>span classw> /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>paid/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>4ZIRR72NQQI65BU7AJBKYEIAAI/span>span classp>,/span>span classw> /span>span classs2>statementDate/span>span classp>:/span>span classw> /span>span classs2>2023-09-08T16:20:57Z/span>span classp>,/span>span classw> /span>span classs2>totalVolume/span>span classp>:/span>span classw> /span>span classmf>513166.46/span>span classp>,/span>span classw> /span>span classs2>totalVolumeFormatted/span>span classp>:/span>span classw> /span>span classs2>513,166.46/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>12341/span>span classp>,/span>span classw> /span>span classs2>partnerCommission/span>span classp>:/span>span classw> /span>span classmf>386.99/span>span classp>,/span>span classw> /span>span classs2>partnerCommissionFormatted/span>span classp>:/span>span classw> /span>span classs2>386.99/span>span classp>,/span>span classw> /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>paid/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>2BRDQHRS6MI65F7UAJBKYEIAAQ/span>span classp>,/span>span classw> /span>span classs2>statementDate/span>span classp>:/span>span classw> /span>span classs2>2023-08-04T21:02:42Z/span>span classp>,/span>span classw> /span>span classs2>totalVolume/span>span classp>:/span>span classw> /span>span classmf>680464.72/span>span classp>,/span>span classw> /span>span classs2>totalVolumeFormatted/span>span classp>:/span>span classw> /span>span classs2>680,464.72/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>17125/span>span classp>,/span>span classw> /span>span classs2>partnerCommission/span>span classp>:/span>span classw> /span>span classmf>639.18/span>span classp>,/span>span classw> /span>span classs2>partnerCommissionFormatted/span>span classp>:/span>span classw> /span>span classs2>639.18/span>span classp>,/span>span classw> /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>paid/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Partner/li>li>strong>Required Role:/strong> Partner API Access/li>/ul>p>The API returns a list of partner residual statements. By default, all statements are returned with the most recentstatements listed first. Optional date parameters (code>startDate/code> and code>endDate/code>) can filter statements to a specific date range./p>p>The list of statements returns basic information about statements like volume, transaction count, and commissions earned./p>p>Use the code>id/code> returned with each statement summary with the em>Partner Statement Detail/em> API to pull down full details./p>h2 idpartner-statement-detail>Partner Statement Detail/h2>blockquote>p>Partner Statement Detail Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>partner-statement-detail/span> -idspan classo>/span>span classs2><STATEMENT_ID>/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>partner-statement-detail/span> -idspan classo>/span>span classs2><STATEMENT_ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>partnerStatementDetailExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>PartnerStatementDetailRequest/span>span classp>{}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>PartnerStatementDetail/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>PartnerStatementDetailRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>PartnerStatementDetailRequest/span>span classp>{/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>PartnerStatementDetailResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>PartnerStatementDetailAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.PartnerStatementDetailRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.PartnerStatementDetailResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>PartnerStatementDetailExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>PartnerStatementDetailRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>PartnerStatementDetailRequest/span>span classo>();/span> span classc1>// Send the request/span> span classn>PartnerStatementDetailResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>partnerStatementDetail/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>partnerStatementDetail/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>partnerStatementDetail/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>partner_statement_detail/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>partnerStatementDetail/span>span classp>({/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>PartnerStatementDetailRequest/span>span classp>();/span>span classnx>client/span>span classp>./span>span classnx>partnerStatementDetail/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>PartnerStatementDetailResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classp>/span>span classn>client/span> span classnf>partnerStatementDetailWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>client/span>span classo>./span>span classnf>partnerStatementDetail/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>partner_statement_detail_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>PartnerStatementDetailRequest/span>span classp>{/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.partner_statement_detail/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>partner_statement_detail_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SCH34K3J7005EJNAJBKYEIAAI/span>span classp>,/span>span classw> /span>span classs2>partnerId/span>span classp>:/span>span classw> /span>span classs2>Y5F3U5NQ7006ZBSUAJBKYEIAAU/span>span classp>,/span>span classw> /span>span classs2>partnerName/span>span classp>:/span>span classw> /span>span classs2>Demo Partner, Inc./span>span classp>,/span>span classw> /span>span classs2>statementDate/span>span classp>:/span>span classw> /span>span classs2>2023-10-23T20:14:06Z/span>span classp>,/span>span classw> /span>span classs2>totalVolume/span>span classp>:/span>span classw> /span>span classmf>548483.05/span>span classp>,/span>span classw> /span>span classs2>totalVolumeFormatted/span>span classp>:/span>span classw> /span>span classs2>548,483.05/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>12175/span>span classp>,/span>span classw> /span>span classs2>partnerCommission/span>span classp>:/span>span classw> /span>span classmf>395.15/span>span classp>,/span>span classw> /span>span classs2>partnerCommissionFormatted/span>span classp>:/span>span classw> /span>span classs2>395.15/span>span classp>,/span>span classw> /span>span classs2>partnerCommissionsOnVolume/span>span classp>:/span>span classw> /span>span classmf>0.0007/span>span classp>,/span>span classw> /span>span classs2>partnerCommissionsOnVolumeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.07%/span>span classp>,/span>span classw> /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>paid/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>UV7DEJLR4AI65OUEAJBKYEIAAM/span>span classp>,/span>span classw> /span>span classs2>invoiceId/span>span classp>:/span>span classw> /span>span classs2>UV7DEJLR4A700OUEAJBKYEIAAM/span>span classp>,/span>span classw> /span>span classs2>totalFees/span>span classp>:/span>span classw> /span>span classmf>8058.21/span>span classp>,/span>span classw> /span>span classs2>totalFeesFormatted/span>span classp>:/span>span classw> /span>span classs2>8,058.21/span>span classp>,/span>span classw> /span>span classs2>totalFeesOnVolume/span>span classp>:/span>span classw> /span>span classmf>0.0166/span>span classp>,/span>span classw> /span>span classs2>totalFeesOnVolumeFormatted/span>span classp>:/span>span classw> /span>span classs2>1.66%/span>span classp>,/span>span classw> /span>span classs2>merchantId/span>span classp>:/span>span classw> /span>span classs2>W5JCF4700I6ZE6KAJBKYEIAAI/span>span classp>,/span>span classw> /span>span classs2>merchantName/span>span classp>:/span>span classw> /span>span classs2>Taco Tuesday, Inc./span>span classp>,/span>span classw> /span>span classs2>dbaName/span>span classp>:/span>span classw> /span>span classs2>Don Juaquins/span>span classp>,/span>span classw> /span>span classs2>statementDate/span>span classp>:/span>span classw> /span>span classs2>2023-09-30T04:28:21Z/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>486611.83/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>486,611.83/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>9628/span>span classp>,/span>span classw> /span>span classs2>interchange/span>span classp>:/span>span classw> /span>span classmf>6175.64/span>span classp>,/span>span classw> /span>span classs2>interchangeFormatted/span>span classp>:/span>span classw> /span>span classs2>6,175.64/span>span classp>,/span>span classw> /span>span classs2>interchangeOnVolume/span>span classp>:/span>span classw> /span>span classmf>0.0127/span>span classp>,/span>span classw> /span>span classs2>interchangeOnVolumeFormatted/span>span classp>:/span>span classw> /span>span classs2>1.27%/span>span classp>,/span>span classw> /span>span classs2>assessments/span>span classp>:/span>span classw> /span>span classmf>653.05/span>span classp>,/span>span classw> /span>span classs2>assessmentsFormatted/span>span classp>:/span>span classw> /span>span classs2>653.05/span>span classp>,/span>span classw> /span>span classs2>assessmentsOnVolume/span>span classp>:/span>span classw> /span>span classmf>0.0013/span>span classp>,/span>span classw> /span>span classs2>assessmentsOnVolumeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.13%/span>span classp>,/span>span classw> /span>span classs2>partnerCommission/span>span classp>:/span>span classw> /span>span classmf>332.88/span>span classp>,/span>span classw> /span>span classs2>partnerCommissionFormatted/span>span classp>:/span>span classw> /span>span classs2>332.88/span>span classp>,/span>span classw> /span>span classs2>buyRate/span>span classp>:/span>span classw> /span>span classmf>569.85/span>span classp>,/span>span classw> /span>span classs2>buyRateFormatted/span>span classp>:/span>span classw> /span>span classs2>569.85/span>span classp>,/span>span classw> /span>span classs2>hardCosts/span>span classp>:/span>span classw> /span>span classmf>215.83/span>span classp>,/span>span classw> /span>span classs2>hardCostsFormatted/span>span classp>:/span>span classw> /span>span classs2>215.83/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>UV7LJ4LR4AI65OUEAJBKYEIAAM/span>span classp>,/span>span classw> /span>span classs2>invoiceId/span>span classp>:/span>span classw> /span>span classs2>UV7DEJLR4A700OUEAJBKYEIAAM/span>span classp>,/span>span classw> /span>span classs2>totalFees/span>span classp>:/span>span classw> /span>span classmf>1237.88/span>span classp>,/span>span classw> /span>span classs2>totalFeesFormatted/span>span classp>:/span>span classw> /span>span classs2>1,237.88/span>span classp>,/span>span classw> /span>span classs2>totalFeesOnVolume/span>span classp>:/span>span classw> /span>span classmf>0.02/span>span classp>,/span>span classw> /span>span classs2>totalFeesOnVolumeFormatted/span>span classp>:/span>span classw> /span>span classs2>2%/span>span classp>,/span>span classw> /span>span classs2>merchantId/span>span classp>:/span>span classw> /span>span classs2>EINES7004I6ZDWLAJBKYEIAAM/span>span classp>,/span>span classw> /span>span classs2>merchantName/span>span classp>:/span>span classw> /span>span classs2>Kneaders/span>span classp>,/span>span classw> /span>span classs2>dbaName/span>span classp>:/span>span classw> /span>span classs2>Kneaders/span>span classp>,/span>span classw> /span>span classs2>statementDate/span>span classp>:/span>span classw> /span>span classs2>2023-09-30T04:28:17Z/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>61871.22/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>61,871.22/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>2547/span>span classp>,/span>span classw> /span>span classs2>interchange/span>span classp>:/span>span classw> /span>span classmf>887.84/span>span classp>,/span>span classw> /span>span classs2>interchangeFormatted/span>span classp>:/span>span classw> /span>span classs2>887.84/span>span classp>,/span>span classw> /span>span classs2>interchangeOnVolume/span>span classp>:/span>span classw> /span>span classmf>0.0143/span>span classp>,/span>span classw> /span>span classs2>interchangeOnVolumeFormatted/span>span classp>:/span>span classw> /span>span classs2>1.43%/span>span classp>,/span>span classw> /span>span classs2>assessments/span>span classp>:/span>span classw> /span>span classmf>81.65/span>span classp>,/span>span classw> /span>span classs2>assessmentsFormatted/span>span classp>:/span>span classw> /span>span classs2>81.65/span>span classp>,/span>span classw> /span>span classs2>assessmentsOnVolume/span>span classp>:/span>span classw> /span>span classmf>0.0013/span>span classp>,/span>span classw> /span>span classs2>assessmentsOnVolumeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.13%/span>span classp>,/span>span classw> /span>span classs2>partnerCommission/span>span classp>:/span>span classw> /span>span classmf>62.27/span>span classp>,/span>span classw> /span>span classs2>partnerCommissionFormatted/span>span classp>:/span>span classw> /span>span classs2>62.27/span>span classp>,/span>span classw> /span>span classs2>buyRate/span>span classp>:/span>span classw> /span>span classmf>130.66/span>span classp>,/span>span classw> /span>span classs2>buyRateFormatted/span>span classp>:/span>span classw> /span>span classs2>130.66/span>span classp>,/span>span classw> /span>span classs2>hardCosts/span>span classp>:/span>span classw> /span>span classmf>54.7/span>span classp>,/span>span classw> /span>span classs2>hardCostsFormatted/span>span classp>:/span>span classw> /span>span classs2>54.70/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>UV7WP6LR4AI65OUEAJBKYEIAAM/span>span classp>,/span>span classw> /span>span classs2>invoiceId/span>span classp>:/span>span classw> /span>span classs2>UV7DEJLR4A700OUEAJBKYEIAAM/span>span classp>,/span>span classw> /span>span classs2>totalFees/span>span classp>:/span>span classw> /span>span classmi>5/span>span classp>,/span>span classw> /span>span classs2>totalFeesFormatted/span>span classp>:/span>span classw> /span>span classs2>5.00/span>span classp>,/span>span classw> /span>span classs2>totalFeesOnVolume/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalFeesOnVolumeFormatted/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>merchantId/span>span classp>:/span>span classw> /span>span classs2>2IHUDFHI7006ZKK3AJBKYEIAAQ/span>span classp>,/span>span classw> /span>span classs2>merchantName/span>span classp>:/span>span classw> /span>span classs2>DP Cheesesteaks/span>span classp>,/span>span classw> /span>span classs2>dbaName/span>span classp>:/span>span classw> /span>span classs2>DP Cheesesteaks/span>span classp>,/span>span classw> /span>span classs2>statementDate/span>span classp>:/span>span classw> /span>span classs2>2023-09-30T04:28:53Z/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>interchange/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>interchangeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>interchangeOnVolume/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>interchangeOnVolumeFormatted/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>assessments/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>assessmentsFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>assessmentsOnVolume/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>assessmentsOnVolumeFormatted/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>partnerCommission/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>partnerCommissionFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>buyRate/span>span classp>:/span>span classw> /span>span classmi>5/span>span classp>,/span>span classw> /span>span classs2>buyRateFormatted/span>span classp>:/span>span classw> /span>span classs2>5.00/span>span classp>,/span>span classw> /span>span classs2>hardCosts/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>hardCostsFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classs2>adjustments/span>span classp>:/span>span classw> /span>span classp>,/span>span classw> /span>span classs2>disbursements/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>CP7VPK3STQI65OUEAJBKYEIAAM/span>span classp>,/span>span classw> /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classs2>2023-10-24T19:08:11Z/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>charge/span>span classp>,/span>span classw> /span>span classs2>paymentType/span>span classp>:/span>span classw> /span>span classs2>ACH/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>*****0000/span>span classp>,/span>span classw> /span>span classs2>pending/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>approved/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>amount/span>span classp>:/span>span classw> /span>span classmf>395.15/span>span classp>,/span>span classw> /span>span classs2>amountFormatted/span>span classp>:/span>span classw> /span>span classs2>395.15/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Partner/li>li>strong>Required Role:/strong> Partner API Access/li>/ul>p>The API returns detailed information about a specific partner statement. Aggregate data is returned along withline item level data for each underlying merchant statement./p>p>Use the merchant invoice id with the em>Merchant Statement Detail/em> API and the em>Partner Commission Breakdown/em> API to get the merchant statement and the card brand fee cost breakdown respectively./p>h2 idmerchant-invoices>Merchant Invoices/h2>blockquote>p>Merchant Invoices Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>merchant-invoices/span> -merchantIdspan classo>/span>span classs2><ID>/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>merchant-invoices/span> -merchantIdspan classo>/span>span classs2><ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>merchantInvoicesExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>MerchantInvoiceListRequest/span>span classp>{}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>MerchantInvoices/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>MerchantInvoiceListRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>MerchantInvoiceListRequest/span>span classp>{/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>MerchantInvoiceListResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>MerchantInvoicesAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.MerchantInvoiceListRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.MerchantInvoiceListResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>MerchantInvoicesExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>MerchantInvoiceListRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>MerchantInvoiceListRequest/span>span classo>();/span> span classc1>// Send the request/span> span classn>MerchantInvoiceListResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>merchantInvoices/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>merchantInvoices/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>merchantInvoices/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>merchant_invoices/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>merchantInvoices/span>span classp>({/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>MerchantInvoiceListRequest/span>span classp>();/span>span classnx>client/span>span classp>./span>span classnx>merchantInvoices/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>MerchantInvoiceListResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classp>/span>span classn>client/span> span classnf>merchantInvoicesWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>client/span>span classo>./span>span classnf>merchantInvoices/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>merchant_invoices_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>MerchantInvoiceListRequest/span>span classp>{/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.merchant_invoices/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>merchant_invoices_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>invoices/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>YXIYN627JEI65FBWAJBKYEIAAQ/span>span classp>,/span>span classw> /span>span classs2>dateCreated/span>span classp>:/span>span classw> /span>span classs2>2023-09-30T04:28:21Z/span>span classp>,/span>span classw> /span>span classs2>grandTotal/span>span classp>:/span>span classw> /span>span classmf>8058.21/span>span classp>,/span>span classw> /span>span classs2>grandTotalFormatted/span>span classp>:/span>span classw> /span>span classs2>8,058.21/span>span classp>,/span>span classw> /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>paid/span>span classp>,/span>span classw> /span>span classs2>invoiceType/span>span classp>:/span>span classw> /span>span classs2>statement/span>span classp>,/span>span classw> /span>span classs2>paid/span>span classp>:/span>span classw> /span>span classkc>true/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>OEXJSDSIPII65NU4AJBKYEIAAM/span>span classp>,/span>span classw> /span>span classs2>dateCreated/span>span classp>:/span>span classw> /span>span classs2>2023-09-01T03:48:48Z/span>span classp>,/span>span classw> /span>span classs2>grandTotal/span>span classp>:/span>span classw> /span>span classmf>7623.67/span>span classp>,/span>span classw> /span>span classs2>grandTotalFormatted/span>span classp>:/span>span classw> /span>span classs2>7,623.67/span>span classp>,/span>span classw> /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>paid/span>span classp>,/span>span classw> /span>span classs2>invoiceType/span>span classp>:/span>span classw> /span>span classs2>statement/span>span classp>,/span>span classw> /span>span classs2>paid/span>span classp>:/span>span classw> /span>span classkc>true/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>IC2W2YBQDYI65OGFAJBKYEIAAY/span>span classp>,/span>span classw> /span>span classs2>dateCreated/span>span classp>:/span>span classw> /span>span classs2>2023-08-01T03:48:23Z/span>span classp>,/span>span classw> /span>span classs2>grandTotal/span>span classp>:/span>span classw> /span>span classmf>7927.52/span>span classp>,/span>span classw> /span>span classs2>grandTotalFormatted/span>span classp>:/span>span classw> /span>span classs2>7,927.52/span>span classp>,/span>span classw> /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>paid/span>span classp>,/span>span classw> /span>span classs2>invoiceType/span>span classp>:/span>span classw> /span>span classs2>statement/span>span classp>,/span>span classw> /span>span classs2>paid/span>span classp>:/span>span classw> /span>span classkc>true/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Partner/li>li>strong>Required Role:/strong> Partner API Access/li>/ul>p>The API returns a list of partner residual statements. By default, all statements are returned with the most recentstatements listed first. Optional date parameters (code>startDate/code> and code>endDate/code>) can filter statements to a specific date range./p>p>The list of statements returns basic information about statements like volume, transaction count, and commissions earned./p>p>Use the code>id/code> returned with each statement summary with the em>Partner Statement Detail/em> API to pull down full details./p>h2 idmerchant-invoice-detail>Merchant Invoice Detail/h2>blockquote>p>Merchant Invoice Detail Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>merchant-invoice-detail/span> -invoiceIdspan classo>/span>span classs2><STATEMENT_ID>/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>merchant-invoice-detail/span> -invoiceIdspan classo>/span>span classs2><STATEMENT_ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>merchantInvoiceDetailExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>MerchantInvoiceDetailRequest/span>span classp>{}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>MerchantInvoiceDetail/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>MerchantInvoiceDetailRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>MerchantInvoiceDetailRequest/span>span classp>{/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>MerchantInvoiceDetailResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>MerchantInvoiceDetailAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.MerchantInvoiceDetailRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.MerchantInvoiceDetailResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>MerchantInvoiceDetailExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>MerchantInvoiceDetailRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>MerchantInvoiceDetailRequest/span>span classo>();/span> span classc1>// Send the request/span> span classn>MerchantInvoiceDetailResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>merchantInvoiceDetail/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>merchantInvoiceDetail/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>merchantInvoiceDetail/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>merchant_invoice_detail/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>merchantInvoiceDetail/span>span classp>({/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>MerchantInvoiceDetailRequest/span>span classp>();/span>span classnx>client/span>span classp>./span>span classnx>merchantInvoiceDetail/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>MerchantInvoiceDetailResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classp>/span>span classn>client/span> span classnf>merchantInvoiceDetailWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>client/span>span classo>./span>span classnf>merchantInvoiceDetail/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>merchant_invoice_detail_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>MerchantInvoiceDetailRequest/span>span classp>{/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.merchant_invoice_detail/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>merchant_invoice_detail_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>YXIYN627JEI6700WAJBKYEIAAQ/span>span classp>,/span>span classw> /span>span classs2>merchantId/span>span classp>:/span>span classw> /span>span classs2>W5JCF4NVX700ZE6KAJBKYEIAAI/span>span classp>,/span>span classw> /span>span classs2>corporateName/span>span classp>:/span>span classw> /span>span classs2>Improv Olympic/span>span classp>,/span>span classw> /span>span classs2>dbaName/span>span classp>:/span>span classw> /span>span classs2>Improv Olympic/span>span classp>,/span>span classw> /span>span classs2>dateCreated/span>span classp>:/span>span classw> /span>span classs2>2023-09-30T04:28:21Z/span>span classp>,/span>span classw> /span>span classs2>status/span>span classp>:/span>span classw> /span>span classs2>paid/span>span classp>,/span>span classw> /span>span classs2>invoiceType/span>span classp>:/span>span classw> /span>span classs2>statement/span>span classp>,/span>span classw> /span>span classs2>pricingType/span>span classp>:/span>span classw> /span>span classs2>interchange/span>span classp>,/span>span classw> /span>span classs2>paid/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>grandTotal/span>span classp>:/span>span classw> /span>span classmf>8058.21/span>span classp>,/span>span classw> /span>span classs2>grandTotalFormatted/span>span classp>:/span>span classw> /span>span classs2>8,058.21/span>span classp>,/span>span classw> /span>span classs2>subtotal/span>span classp>:/span>span classw> /span>span classmf>8058.21/span>span classp>,/span>span classw> /span>span classs2>subotalFormatted/span>span classp>:/span>span classw> /span>span classs2>8,058.21/span>span classp>,/span>span classw> /span>span classs2>taxTotal/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>taxTotalFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>shippingCost/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>shippingCostFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>balanceDue/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>balanceDueFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>shippingAddress/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>address1/span>span classp>:/span>span classw> /span>span classs2>1060 W Addison/span>span classp>,/span>span classw> /span>span classs2>address2/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>city/span>span classp>:/span>span classw> /span>span classs2>Chicago/span>span classp>,/span>span classw> /span>span classs2>stateOrProvince/span>span classp>:/span>span classw> /span>span classs2>IL/span>span classp>,/span>span classw> /span>span classs2>postalCode/span>span classp>:/span>span classw> /span>span classs2>60446/span>span classp>,/span>span classw> /span>span classs2>countryCode/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>latitude/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>longitude/span>span classp>:/span>span classw> /span>span classmi>0/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>billingAddress/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>address1/span>span classp>:/span>span classw> /span>span classs2>1060 W Addison/span>span classp>,/span>span classw> /span>span classs2>address2/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>city/span>span classp>:/span>span classw> /span>span classs2>Chicago/span>span classp>,/span>span classw> /span>span classs2>stateOrProvince/span>span classp>:/span>span classw> /span>span classs2>IL/span>span classp>,/span>span classw> /span>span classs2>postalCode/span>span classp>:/span>span classw> /span>span classs2>60446/span>span classp>,/span>span classw> /span>span classs2>countryCode/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>latitude/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>longitude/span>span classp>:/span>span classw> /span>span classmi>0/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SIRMMLDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>header/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Interchange Fees/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>These are fees the credit card brands charge. Seems fair. They work hard on those logos./span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>6175.64/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>6,175.64/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKHU4WTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>header/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Visa/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>2247.73/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>2,247.73/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SISHUOTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS Electronic/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>7/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>149.85/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>149.85/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.011/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.1%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>1.6400000000000001/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>149.85 @ 1.1%/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>1.6400000000000001/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>1.64/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SISR7RTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS Credit Voucher Non PT Credit/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>-1/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>-122.64/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>-122.64/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0176/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.76%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>-2.16/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>-122.64 @ 1.76%/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>-2.16/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>-2.16/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SITGU4DU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS CPS Retail Check Debit/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>395/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>16704.31/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>16,704.31/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.15/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.15/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.008/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.8%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>192.9/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$16,704.31 @ 0.8%/span>span classse>\n/span>span classs2>395 x $0.15/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>192.9/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>192.90/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SITVVLDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS CPS Small Ticket Debit/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>108/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>1029.89/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>1,029.89/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.04/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.04/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0155/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.55%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>20.29/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$1,029.89 @ 1.55%/span>span classse>\n/span>span classs2>108 x $0.04/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>20.29/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>20.29/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SIUB74DU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS Business Tr1 Prod 2/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>3/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>50.23/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>50.23/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.019/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.9%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>1.26/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$50.23 @ 1.9%/span>span classse>\n/span>span classs2>3 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>1.26/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>1.26/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SIUOC7TU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS US Corporate Card - Card Present/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>92.43/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>92.43/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.025/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>2.5%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>2.41/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$92.43 @ 2.5%/span>span classse>\n/span>span classs2>1 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>2.41/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>2.41/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SIU3E4DU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS US Purchasing Card - Card Present/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>2/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>108.21/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>108.21/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.025/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>2.5%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>2.9/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$108.21 @ 2.5%/span>span classse>\n/span>span classs2>2 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>2.9/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>2.90/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SIVFAGDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS InterReg Corporate/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>66.89/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>66.89/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.02/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>2%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>1.34/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>66.89 @ 2%/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>1.34/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>1.34/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SIVVLHTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS Business Purchase Retail Prepaid/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>17/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>405.08/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>405.08/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0215/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>2.15%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>10.41/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$405.08 @ 2.15%/span>span classse>\n/span>span classs2>17 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>10.41/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>10.41/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SIWYH6TU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS Business Tr4 Prod 2/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>14/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>2233.69/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>2,233.69/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.022/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>2.2%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>50.54/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$2,233.69 @ 2.2%/span>span classse>\n/span>span classs2>14 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>50.54/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>50.54/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SIXRNITU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS Business Tr 5 Prod 2/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>9/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>5741.09/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>5,741.09/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0225/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>2.25%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>130.08/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$5,741.09 @ 2.25%/span>span classse>\n/span>span classs2>9 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>130.08/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>130.08/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SIYFMIDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS VT Product 2/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>135/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>7432.45/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>7,432.45/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0151/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.51%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>125.74/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$7,432.45 @ 1.51%/span>span classse>\n/span>span classs2>135 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>125.74/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>125.74/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SIYSIJDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS VTR Product 2/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>77/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>5828.89/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>5,828.89/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0165/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.65%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>103.82/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$5,828.89 @ 1.65%/span>span classse>\n/span>span classs2>77 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>103.82/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>103.82/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SIZWGEDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS VIN Product 2/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>462/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>25098.56/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>25,098.56/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0165/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.65%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>460.15/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$25,098.56 @ 1.65%/span>span classse>\n/span>span classs2>462 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>460.15/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>460.15/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJJE3QDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS Premium Card/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>2/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>118.17/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>118.17/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.018/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.8%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>2.13/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>118.17 @ 1.8%/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>2.13/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>2.13/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJJYHNTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS InterReg Super Premium/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>20.06/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>20.06/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0197/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.97%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>0.4/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>20.06 @ 1.97%/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>0.4/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>0.40/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJKTHFTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS Business Tr2 Prod 2/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>47/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>2525.34/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>2,525.34/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0205/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>2.05%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>56.54/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$2,525.34 @ 2.05%/span>span classse>\n/span>span classs2>47 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>56.54/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>56.54/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJK22MDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS Business Tr3 Prod 2/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>13/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>1178.42/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>1,178.42/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.021/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>2.1%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>26.04/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$1,178.42 @ 2.1%/span>span classse>\n/span>span classs2>13 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>26.04/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>26.04/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJLW7HTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS InterReg Regulated Debit/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>17.83/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>17.83/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.22/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.22/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0005/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.05%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>0.23/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$17.83 @ 0.05%/span>span classse>\n/span>span classs2>1 x $0.22/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>0.23/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>0.23/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJMGLVDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS CPS Small Ticket Pp/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>59/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>521.88/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>521.88/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.05/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.05/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.016/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.6%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>11.3/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$521.88 @ 1.6%/span>span classse>\n/span>span classs2>59 x $0.05/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>11.3/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>11.30/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJMTTIDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS CPS Small Ticket Regulated/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>704/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>6734.91/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>6,734.91/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.22/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.22/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0005/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.05%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>158.76/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$6,734.91 @ 0.05%/span>span classse>\n/span>span classs2>704 x $0.22/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>158.76/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>158.76/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJNANPTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS US Regulated Debit/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>3228/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>168064.33/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>168,064.33/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.22/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.22/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0005/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.05%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>794.27/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$168,064.33 @ 0.05%/span>span classse>\n/span>span classs2>3,228 x $0.22/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>794.27/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>794.27/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJNUHRTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS CPS Retail Pp/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>147/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>5200.96/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>5,200.96/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.15/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.15/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0115/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.15%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>81.9/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$5,200.96 @ 1.15%/span>span classse>\n/span>span classs2>147 x $0.15/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>81.9/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>81.90/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJN6L3DU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS Business Card CP Debit/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>21/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>748.4/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>748.40/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.017/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.7%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>14.84/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$748.40 @ 1.7%/span>span classse>\n/span>span classs2>21 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>14.84/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>14.84/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKIIHRDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>header/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Mastercard/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>1886.79/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>1,886.79/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJOJH2DU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Merit III Credit/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>53/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>2880.67/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>2,880.67/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0165/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.65%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>52.81/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$2,880.67 @ 1.65%/span>span classse>\n/span>span classs2>53 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>52.81/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>52.81/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJOUL7TU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Corporate Data Rate 1/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>17/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>741.57/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>741.57/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0265/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>2.65%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>21.32/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$741.57 @ 2.65%/span>span classse>\n/span>span classs2>17 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>21.32/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>21.32/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJPBD4DU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Commercial Rate 1 Large Market/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>14/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>1254.57/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>1,254.57/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.027/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>2.7%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>35.29/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$1,254.57 @ 2.7%/span>span classse>\n/span>span classs2>14 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>35.29/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>35.29/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJPG3PDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Enhanced Merit III Base/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>170/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>8911.28/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>8,911.28/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.018/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.8%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>177.26/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$8,911.28 @ 1.8%/span>span classse>\n/span>span classs2>170 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>177.26/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>177.26/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJPRT5TU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Merit III Debit/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>236/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>7732.66/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>7,732.66/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.15/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.15/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0105/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.05%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>116.64/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$7,732.66 @ 1.05%/span>span classse>\n/span>span classs2>236 x $0.15/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>116.64/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>116.64/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJREIKDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Consumer Credit Refund Group 4/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>-1/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>-50.16/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>-50.16/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0175/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.75%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>-0.88/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>-50.16 @ 1.75%/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>-0.88/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>-0.88/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJRYUBDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC World Merit III/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>122/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>8218.31/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>8,218.31/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.019/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.9%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>168.41/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$8,218.31 @ 1.9%/span>span classse>\n/span>span classs2>122 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>168.41/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>168.41/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJSGDEDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC World Elite Merit III/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>368/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>27357.29/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>27,357.29/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.023/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>2.3%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmi>666/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$27,357.29 @ 2.3%/span>span classse>\n/span>span classs2>368 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmi>666/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>666.00/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJTCAKTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Business Level 4 Data Rate I/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>33.44/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>33.44/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0295/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>2.95%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>1.09/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$33.44 @ 2.95%/span>span classse>\n/span>span classs2>1 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>1.09/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>1.09/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJTQI7DU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Business Level 1 Data Rate I/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>45.68/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>45.68/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0265/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>2.65%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>1.31/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$45.68 @ 2.65%/span>span classse>\n/span>span classs2>1 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>1.31/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>1.31/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJUXIZDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Business Level 5 Data Rate I/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>2/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>77.86/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>77.86/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.03/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>3%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>2.5300000000000002/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$77.86 @ 3%/span>span classse>\n/span>span classs2>2 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>2.5300000000000002/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>2.53/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJVBZ7DU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Merit 3 Prepaid/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>54/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>1187.43/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>1,187.43/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.15/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.15/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0115/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.15%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>21.75/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$1,187.43 @ 1.15%/span>span classse>\n/span>span classs2>54 x $0.15/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>21.75/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>21.75/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJVTOGDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Small Ticket Card Present/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>3/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>11.56/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>11.56/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.02/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.02/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0165/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.65%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>0.24/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$11.56 @ 1.65%/span>span classse>\n/span>span classs2>3 x $0.02/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>0.24/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>0.24/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJWPPWDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC World Small Ticket Card Present/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>4.45/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>4.45/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.02/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.02/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.019/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.9%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$4.45 @ 1.9%/span>span classse>\n/span>span classs2>1 x $0.02/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJW6HSDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC World Elite Small Ticket Card Present/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>8/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>29.06/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>29.06/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.02/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.02/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.023/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>2.3%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>0.84/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$29.06 @ 2.3%/span>span classse>\n/span>span classs2>8 x $0.02/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>0.84/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>0.84/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJXDSVDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Consumer Rate 2-Card Present Core/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>8/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>409.93/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>409.93/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.011/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.1%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>4.52/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>409.93 @ 1.1%/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>4.52/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>4.52/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJXRIZDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC High Value Merit III Base 1/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>43/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>5656.44/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>5,656.44/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.023/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>2.3%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>134.42/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$5,656.44 @ 2.3%/span>span classse>\n/span>span classs2>43 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>134.42/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>134.42/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKCCGGDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Business Level 2 Data Rate I/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>530.87/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>530.87/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.028/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>2.8%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>14.96/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$530.87 @ 2.8%/span>span classse>\n/span>span classs2>1 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>14.96/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>14.96/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKCWQXTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC US Cons Regulated POS Debit w/Fraud Adj/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>1956/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>75924.61/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>75,924.61/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.22/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.22/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0005/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.05%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>468.18/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$75,924.61 @ 0.05%/span>span classse>\n/span>span classs2>1,956 x $0.22/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>468.18/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>468.18/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKIQSIDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>header/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>American Express/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>418.89/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>418.89/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKC6Z2DU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>AM Retail Tier 1/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>106/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>3483.88/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>3,483.88/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.016/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.6%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>66.31/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$3,483.88 @ 1.6%/span>span classse>\n/span>span classs2>106 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>66.31/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>66.31/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKDHTWDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>AM Retail Tier 2/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>50/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>9545.76/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>9,545.76/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0195/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.95%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>191.15/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$9,545.76 @ 1.95%/span>span classse>\n/span>span classs2>50 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>191.15/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>191.15/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKDQXDDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>AM Retail Tier 3/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>3/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>6693.79/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>6,693.79/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.024/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>2.4%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>160.95/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$6,693.79 @ 2.4%/span>span classse>\n/span>span classs2>3 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>160.95/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>160.95/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKEOQ5TU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>AM Prepaid Tier 1/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>27.85/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>27.85/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0135/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.35%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>0.48/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$27.85 @ 1.35%/span>span classse>\n/span>span classs2>1 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>0.48/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>0.48/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKJSGITU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>header/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Discover/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>462.86/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>462.86/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKFJMHDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>DS PSL Retail Rewards/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>191/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>10693.91/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>10,693.91/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0172/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.72%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>203.06/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$10,693.91 @ 1.72%/span>span classse>\n/span>span classs2>191 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>203.06/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>203.06/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKFQRGTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>DS PSL Retail DB/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>24/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>821.15/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>821.15/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.16/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.16/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.011/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.1%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>12.89/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$821.15 @ 1.1%/span>span classse>\n/span>span classs2>24 x $0.16/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>12.89/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>12.89/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKGB6HTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>DS Commercial Electronic Submission Level/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>39/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>2271.61/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>2,271.61/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.15/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.15/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0245/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>2.45%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>61.5/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$2,271.61 @ 2.45%/span>span classse>\n/span>span classs2>39 x $0.15/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>61.5/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>61.50/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKGRGQTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>DS PSL - Retail Prepaid/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>2/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>83.57/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>83.57/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.16/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.16/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0112/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.12%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>1.25/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$83.57 @ 1.12%/span>span classse>\n/span>span classs2>2 x $0.16/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>1.25/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>1.25/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKGXGCTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>DS PSL Retail PR/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>36/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>10176.1/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>10,176.10/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0174/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>1.74%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>180.69/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$10,176.10 @ 1.74%/span>span classse>\n/span>span classs2>36 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>180.69/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>180.69/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKHFGVTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>DS Retail (Premium Plus)/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>3/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>140.99/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>140.99/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0225/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>2.25%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>3.4699999999999998/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$140.99 @ 2.25%/span>span classse>\n/span>span classs2>3 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>3.4699999999999998/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>3.47/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKKAFETU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>header/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Debit/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>1159.37/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>1,159.37/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SI2EVDDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Visa Signature Preferred Product 2/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>627/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>49779.42/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>49,779.42/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.021/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>2.1%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmi>1108/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$49,779.42 @ 2.1%/span>span classse>\n/span>span classs2>627 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmi>1108/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>1,108.00/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SI3AFIDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Visa VIQ Product 2/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>22/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>1942.96/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>1,942.96/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.021/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>2.1%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>42.98/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$1,942.96 @ 2.1%/span>span classse>\n/span>span classs2>22 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>42.98/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>42.98/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SJSOWBTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Commercial Data Rate 1 Level 3/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>12/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>252.5/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>252.50/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0285/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>2.85%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>8.39/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$252.50 @ 2.85%/span>span classse>\n/span>span classs2>12 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>8.39/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>8.39/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKKVUUTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>header/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Other Passthrough Fees/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>These are other bank and card brand fees we have no control over./span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>657.56/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>657.56/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKPZ7PDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>header/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Visa/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>404.3/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>404.30/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKLL5WDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS-IAF/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>13/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>454.15/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>454.15/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0045/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.45%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>2.05/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>454.15 @ 0.45%/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>2.05/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>2.05/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKLXH4DU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS-ASSMNT CREDIT/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>1414/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>102098.64/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>102,098.64/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0014/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.14%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>142.96/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>102,098.64 @ 0.14%/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>142.96/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>142.96/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKMDZ5DU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS-ASSMNT DEBIT/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>4689/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>199695.61/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>199,695.61/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0013/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.13%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>259.29/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>199,695.61 @ 0.13%/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>259.29/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>259.29/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKRPJKTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>header/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Mastercard/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>186.8/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>186.80/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKMPSADU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC-ACQ Brnd Vol ABV/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>4/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>8898.36/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>8,898.36/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0014/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.14%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>12.46/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>8,898.36 @ 0.14%/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>12.46/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>12.46/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKM43CTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC-ACQ Brand Volume/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>3066/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>132361.82/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>132,361.82/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0013/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.13%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>171.88/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>132,361.82 @ 0.13%/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>171.88/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>171.88/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKNRYJTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC-CRBDR - Domestic/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>8/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>409.93/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>409.93/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.006/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.6%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>2.46/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>409.93 @ 0.6%/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>2.46/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>2.46/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKSBLWDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>header/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>American Express/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>32.6/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>32.60/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKN3NYDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>AM-AM USASSMNTFEE/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>160/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>19751.28/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>19,751.28/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.00165/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.165%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>32.6/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>19,751.28 @ 0.165%/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>32.6/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>32.60/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SMF43VTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>header/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Discover/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>33.86/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>33.86/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SKPDDGTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>DS-DS Assessment/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>295/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>24187.33/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>24,187.33/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.0014/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.14%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>33.86/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>24,187.33 @ 0.14%/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>33.86/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>33.86/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SMHGCITU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>header/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>BlockChyp Fees/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>These are the fees BlockChyp collects. We use them to keep the office stocked with La Croix and board games./span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>1215.01/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>1,215.01/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SMJQHPDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Chip-VS/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>1320/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>90021.36/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>90,021.36/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.05/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.05/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.001/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.1%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>156.02/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$90,021.36 @ 0.1%/span>span classse>\n/span>span classs2>1,320 x $0.05/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>156.02/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>156.02/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SMKSOWTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Chip-VD/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>4630/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>198012.1/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>198,012.10/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.081/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.081/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.001/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.1%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>573.04/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$198,012.10 @ 0.1%/span>span classse>\n/span>span classs2>4,630 x $0.081/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>573.04/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>573.04/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SMK3YBTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Chip-VB/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>90/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>11996.3/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>11,996.30/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.05/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.05/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.001/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.1%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>16.5/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$11,996.30 @ 0.1%/span>span classse>\n/span>span classs2>90 x $0.05/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>16.5/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>16.50/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SMLH33TU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Chip-MC/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>765/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>52950.24/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>52,950.24/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.05/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.05/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.001/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.1%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>91.2/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$52,950.24 @ 0.1%/span>span classse>\n/span>span classs2>765 x $0.05/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>91.2/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>91.20/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SMLR3FDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Chip-MD/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>2220/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>84571.84/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>84,571.84/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.081/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.081/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.001/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.1%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>264.39/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$84,571.84 @ 0.1%/span>span classse>\n/span>span classs2>2,220 x $0.081/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>264.39/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>264.39/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SMME3BTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Chip-MB/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>30/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>2181.55/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>2,181.55/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.05/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.05/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.001/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.1%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>3.68/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$2,181.55 @ 0.1%/span>span classse>\n/span>span classs2>30 x $0.05/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>3.68/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>3.68/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SMMO77DU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Chip-AM/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>159/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>19723.43/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>19,723.43/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.002/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.2%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>55.35/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$19,723.43 @ 0.2%/span>span classse>\n/span>span classs2>159 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>55.35/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>55.35/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SMMXMXDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Chip-DS/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>230/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmi>21011/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>21,011.00/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.05/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.05/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.001/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.1%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>32.51/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$21,011.00 @ 0.1%/span>span classse>\n/span>span classs2>230 x $0.05/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>32.51/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>32.51/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SMNKM3DU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Chip-DD/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>26/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>904.72/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>904.72/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.081/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.081/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.001/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.1%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>3.01/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$904.72 @ 0.1%/span>span classse>\n/span>span classs2>26 x $0.081/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>3.01/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>3.01/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SMOB3PDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Chip-DZ/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>39/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>2271.61/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>2,271.61/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.05/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.05/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.001/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.1%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>4.22/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$2,271.61 @ 0.1%/span>span classse>\n/span>span classs2>39 x $0.05/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>4.22/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>4.22/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SMRHRTTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Fallback-VS/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>2/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>59.06/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>59.06/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.05/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.05/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.001/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.1%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>0.16/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$59.06 @ 0.1%/span>span classse>\n/span>span classs2>2 x $0.05/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>0.16/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>0.16/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SMTKH2TU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Fallback-VD/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>4/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>235.21/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>235.21/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.081/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.081/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.001/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.1%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>0.56/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$235.21 @ 0.1%/span>span classse>\n/span>span classs2>4 x $0.081/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>0.56/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>0.56/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SMT4OIDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Fallback-MC/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>22.28/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>22.28/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.05/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.05/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.001/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.1%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>0.07/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$22.28 @ 0.1%/span>span classse>\n/span>span classs2>1 x $0.05/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>0.07/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>0.07/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SM3YFIDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Fallback-MD/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>3/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>276.63/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>276.63/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.081/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.081/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.001/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.1%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>0.52/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$276.63 @ 0.1%/span>span classse>\n/span>span classs2>3 x $0.081/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>0.52/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>0.52/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SM4HREDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Fallback-MB/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>13.37/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>13.37/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.05/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.05/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.001/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.1%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>0.06/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$13.37 @ 0.1%/span>span classse>\n/span>span classs2>1 x $0.05/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>0.06/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>0.06/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SM4SSKTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Swiped/EMV Enabled-VS/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>2/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>21.92/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>21.92/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.05/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.05/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.001/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.1%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>0.12/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$21.92 @ 0.1%/span>span classse>\n/span>span classs2>2 x $0.05/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>0.12/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>0.12/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SM4Z2EDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Swiped/EMV Enabled-VD/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>55/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>1448.3/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>1,448.30/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.081/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.081/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.001/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.1%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>5.9/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$1,448.30 @ 0.1%/span>span classse>\n/span>span classs2>55 x $0.081/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>5.9/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>5.90/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SM5ADYTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Swiped/EMV Enabled-MC/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>5/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>207.07/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>207.07/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.05/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.05/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.001/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.1%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>0.46/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$207.07 @ 0.1%/span>span classse>\n/span>span classs2>5 x $0.05/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>0.46/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>0.46/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SM5K6UTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Swiped/EMV Enabled-MD/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>45/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>1037.2/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>1,037.20/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.081/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.081/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.001/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.1%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>4.68/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$1,037.20 @ 0.1%/span>span classse>\n/span>span classs2>45 x $0.081/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>4.68/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>4.68/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SM6FHBDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>count-and-volume/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Swiped/EMV Enabled-AM/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>27.85/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>27.85/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmf>0.002/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0.2%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>0.16/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>$27.85 @ 0.2%/span>span classse>\n/span>span classs2>1 x $0.10/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>0.16/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>0.16/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SM6WSXTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>tx-count/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Batch Fee/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>30/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmf>0.08/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.08/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmf>2.4/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>30 x $0.08/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmf>2.4/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>2.40/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SM7VV7DU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>header/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Misc Fees/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>These are uncommon and unusual fees that occassionally crop up./span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmi>10/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>10.00/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SNAJQDTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>lineType/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>productId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>quantity/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Monthly Fee/span>span classp>,/span>span classw> /span>span classs2>explanation/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>perTransactionFee/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>perTransactionFeeFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionPercentage/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>price/span>span classp>:/span>span classw> /span>span classmi>10/span>span classp>,/span>span classw> /span>span classs2>priceFormatted/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>priceExtended/span>span classp>:/span>span classw> /span>span classmi>10/span>span classp>,/span>span classw> /span>span classs2>priceExtendedFormatted/span>span classp>:/span>span classw> /span>span classs2>10.00/span>span classp>,/span>span classw> /span>span classs2>lineItems/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classs2>payments/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SNAUJNTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classs2>2023-10-27T18:06:58Z/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>TSYS/span>span classp>,/span>span classw> /span>span classs2>paymentType/span>span classp>:/span>span classw> /span>span classs2>TSYS ACH/span>span classp>,/span>span classw> /span>span classs2>authCode/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>****0000/span>span classp>,/span>span classw> /span>span classs2>pending/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>approved/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>SUBMITTED TO FED/span>span classp>,/span>span classw> /span>span classs2>amount/span>span classp>:/span>span classw> /span>span classmf>8058.21/span>span classp>,/span>span classw> /span>span classs2>amountFormatted/span>span classp>:/span>span classw> /span>span classs2>8,058.21/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classs2>deposits/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SNBQZJTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>230/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>10854.53/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>10,854.53/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>10854.53/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>10,854.53/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SNCXKBDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>328/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>18320.2/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>18,320.20/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>18320.2/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>18,320.20/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SNB3JFDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>599/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>29308.32/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>29,308.32/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>29308.32/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>29,308.32/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SNDTOITU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>635/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>31839.34/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>31,839.34/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>31839.34/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>31,839.34/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SNECGJTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>19/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>449.25/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>449.25/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>449.25/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>449.25/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SNE26DDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>503/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>25812.21/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>25,812.21/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>25812.21/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>25,812.21/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SNGYFUDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>277/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>10753.31/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>10,753.31/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>10753.31/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>10,753.31/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SNH656DU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>132/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>4264.1/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>4,264.10/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>4264.1/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>4,264.10/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SNJD5OTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>239/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>34091.34/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>34,091.34/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>34091.34/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>34,091.34/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SNJ24WDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>492/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>28462.69/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>28,462.69/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>28466.02/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>28,466.02/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmf>3.33/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>3.33/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SNQ6TFTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>238/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>10953.64/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>10,953.64/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>10953.64/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>10,953.64/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SNRK3JDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>583/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>29009.22/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>29,009.22/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>29009.22/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>29,009.22/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SNRTVADU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>293/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>10220.47/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>10,220.47/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>10220.47/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>10,220.47/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SNSE2HDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>144/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>8442.06/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>8,442.06/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>8442.06/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>8,442.06/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SOV4GBDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>162/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>7534.13/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>7,534.13/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>7534.13/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>7,534.13/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SOWZYODU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>224/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>10763.65/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>10,763.65/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>10773.69/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>10,773.69/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmf>10.04/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>10.04/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SOXT77DU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>276/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>12528.69/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>12,528.69/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>12528.69/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>12,528.69/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SOXGNLTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>620/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>34943.14/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>34,943.14/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>34993.3/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>34,993.30/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmf>50.16/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>50.16/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SOX5LXTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>586/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>32064.72/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>32,064.72/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>32223.03/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>32,223.03/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmf>158.31/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>158.31/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SOYNB5TU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>232/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>9773.48/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>9,773.48/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>9773.48/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>9,773.48/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SOY7BKDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>148/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>4369.79/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>4,369.79/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>4369.79/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>4,369.79/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SOZOURDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>157/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>7073.39/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>7,073.39/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>7073.39/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>7,073.39/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SOZZADDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>223/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>12427.9/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>12,427.90/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>12427.9/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>12,427.90/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SO2LPBDU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>558/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>27126.43/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>27,126.43/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>27126.43/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>27,126.43/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SO2326DU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>275/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>13371.34/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>13,371.34/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>13371.34/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>13,371.34/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SO3K6ETU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>638/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>29393.37/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>29,393.37/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>29393.37/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>29,393.37/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SO375CTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>282/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>10895.79/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>10,895.79/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>10895.79/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>10,895.79/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SO4UX6TU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>160/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>5154.05/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>5,154.05/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>5194.16/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>5,194.16/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmf>40.11/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>40.11/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SO6OPYTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>169/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>5940.67/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>5,940.67/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>6059.93/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>6,059.93/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmf>119.26/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>119.26/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>SO7LQQTU6MI65KNZTYA4RH54WI/span>span classp>,/span>span classw> /span>span classs2>transactionCount/span>span classp>:/span>span classw> /span>span classmi>206/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>feesPaid/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>feesPaidFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>netDeposit/span>span classp>:/span>span classw> /span>span classmf>10470.61/span>span classp>,/span>span classw> /span>span classs2>netDepositFormatted/span>span classp>:/span>span classw> /span>span classs2>10,470.61/span>span classp>,/span>span classw> /span>span classs2>totalSales/span>span classp>:/span>span classw> /span>span classmf>10470.61/span>span classp>,/span>span classw> /span>span classs2>totalSalesFormatted/span>span classp>:/span>span classw> /span>span classs2>10,470.61/span>span classp>,/span>span classw> /span>span classs2>totalRefunds/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalRefundsFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Partner/li>li>strong>Required Role:/strong> Partner API Access/li>/ul>p>The API returns detailed information about a specific merchant statement or invoice./p>p>All line items are returned a topographically sorted tree modeling the nested line item structure of the invoice. Details about any payments posted against the invoice are returned./p>p>It the invoice is a merchant statement, details about every merchant deposit that occurred during the statement periodare also returned./p>h2 idpartner-commission-breakdown>Partner Commission Breakdown/h2>blockquote>p>Partner Commission Breakdown Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>partner-commission-breakdown/span> -statementIdspan classo>/span>span classs2><STATEMENT_ID>/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>partner-commission-breakdown/span> -statementIdspan classo>/span>span classs2><STATEMENT_ID>/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>partnerCommissionBreakdownExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>PartnerCommissionBreakdownRequest/span>span classp>{}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>PartnerCommissionBreakdown/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>PartnerCommissionBreakdownRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>PartnerCommissionBreakdownRequest/span>span classp>{/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>PartnerCommissionBreakdownResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>PartnerCommissionBreakdownAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.PartnerCommissionBreakdownRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.PartnerCommissionBreakdownResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>PartnerCommissionBreakdownExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>PartnerCommissionBreakdownRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>PartnerCommissionBreakdownRequest/span>span classo>();/span> span classc1>// Send the request/span> span classn>PartnerCommissionBreakdownResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>partnerCommissionBreakdown/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>partnerCommissionBreakdown/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>partnerCommissionBreakdown/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>partner_commission_breakdown/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>partnerCommissionBreakdown/span>span classp>({/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>PartnerCommissionBreakdownRequest/span>span classp>();/span>span classnx>client/span>span classp>./span>span classnx>partnerCommissionBreakdown/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>PartnerCommissionBreakdownResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classp>/span>span classn>client/span> span classnf>partnerCommissionBreakdownWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>client/span>span classo>./span>span classnf>partnerCommissionBreakdown/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>partner_commission_breakdown_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>PartnerCommissionBreakdownRequest/span>span classp>{/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.partner_commission_breakdown/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>partner_commission_breakdown_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>invoiceId/span>span classp>:/span>span classw> /span>span classs2>YXIYN627J7005FBWAJBKYEIAAQ/span>span classp>,/span>span classw> /span>span classs2>partnerName/span>span classp>:/span>span classw> /span>span classs2>Demo Partner, Inc./span>span classp>,/span>span classw> /span>span classs2>partnerStatementId/span>span classp>:/span>span classw> /span>span classs2>SCH34K3JAEI65EJNAJBKYEIAAI/span>span classp>,/span>span classw> /span>span classs2>partnerStatementDate/span>span classp>:/span>span classw> /span>span classs2>2023-09-30T04:28:21Z/span>span classp>,/span>span classw> /span>span classs2>merchantId/span>span classp>:/span>span classw> /span>span classs2>W5JCF4NVXAI6ZE6K700KYEIAAI/span>span classp>,/span>span classw> /span>span classs2>merchantCompanyName/span>span classp>:/span>span classw> /span>span classs2>Tacos Panjamo/span>span classp>,/span>span classw> /span>span classs2>merchantDbaName/span>span classp>:/span>span classw> /span>span classs2>Tacos Panjamo/span>span classp>,/span>span classw> /span>span classs2>grandTotal/span>span classp>:/span>span classw> /span>span classmf>8058.21/span>span classp>,/span>span classw> /span>span classs2>grandTotalFormatted/span>span classp>:/span>span classw> /span>span classs2>8,058.21/span>span classp>,/span>span classw> /span>span classs2>totalFees/span>span classp>:/span>span classw> /span>span classmf>8058.21/span>span classp>,/span>span classw> /span>span classs2>totalFeesFormatted/span>span classp>:/span>span classw> /span>span classs2>8,058.21/span>span classp>,/span>span classw> /span>span classs2>totalDue/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalDueFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>totalVolume/span>span classp>:/span>span classw> /span>span classmf>486611.83/span>span classp>,/span>span classw> /span>span classs2>totalVolumeFormatted/span>span classp>:/span>span classw> /span>span classs2>486,611.83/span>span classp>,/span>span classw> /span>span classs2>totalTransactions/span>span classp>:/span>span classw> /span>span classmi>9628/span>span classp>,/span>span classw> /span>span classs2>partnerResidual/span>span classp>:/span>span classw> /span>span classmf>332.88/span>span classp>,/span>span classw> /span>span classs2>partnerResidualFormatted/span>span classp>:/span>span classw> /span>span classs2>332.88/span>span classp>,/span>span classw> /span>span classs2>interchange/span>span classp>:/span>span classw> /span>span classmf>6175.64/span>span classp>,/span>span classw> /span>span classs2>interchangeFormatted/span>span classp>:/span>span classw> /span>span classs2>6,175.64/span>span classp>,/span>span classw> /span>span classs2>assessments/span>span classp>:/span>span classw> /span>span classmf>653.05/span>span classp>,/span>span classw> /span>span classs2>assessmentsFormatted/span>span classp>:/span>span classw> /span>span classs2>653.05/span>span classp>,/span>span classw> /span>span classs2>totalPassthrough/span>span classp>:/span>span classw> /span>span classmf>6828.69/span>span classp>,/span>span classw> /span>span classs2>totalPassthroughFormatted/span>span classp>:/span>span classw> /span>span classs2>6,828.69/span>span classp>,/span>span classw> /span>span classs2>totalNonPassthrough/span>span classp>:/span>span classw> /span>span classmf>215.83/span>span classp>,/span>span classw> /span>span classs2>totalNonPassthroughFormatted/span>span classp>:/span>span classw> /span>span classs2>215.83/span>span classp>,/span>span classw> /span>span classs2>totalCardBrandFees/span>span classp>:/span>span classw> /span>span classmf>7044.52/span>span classp>,/span>span classw> /span>span classs2>totalCardBrandFeesFormatted/span>span classp>:/span>span classw> /span>span classs2>7,044.52/span>span classp>,/span>span classw> /span>span classs2>totalBuyRate/span>span classp>:/span>span classw> /span>span classmf>7398.54/span>span classp>,/span>span classw> /span>span classs2>totalBuyRateFormatted/span>span classp>:/span>span classw> /span>span classs2>7,398.54/span>span classp>,/span>span classw> /span>span classs2>buyRateBeforePassthrough/span>span classp>:/span>span classw> /span>span classmf>569.85/span>span classp>,/span>span classw> /span>span classs2>buyRateBeforePassthroughFormatted/span>span classp>:/span>span classw> /span>span classs2>569.85/span>span classp>,/span>span classw> /span>span classs2>netMarkup/span>span classp>:/span>span classw> /span>span classmf>443.84/span>span classp>,/span>span classw> /span>span classs2>netMarkupFormatted/span>span classp>:/span>span classw> /span>span classs2>443.84/span>span classp>,/span>span classw> /span>span classs2>partnerNonPassthroughShare/span>span classp>:/span>span classw> /span>span classmf>161.87/span>span classp>,/span>span classw> /span>span classs2>partnerNonPassthroughShareFormatted/span>span classp>:/span>span classw> /span>span classs2>161.87/span>span classp>,/span>span classw> /span>span classs2>chargebackFees/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>chargebackFeesFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>chargebackCount/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>partnerPercentage/span>span classp>:/span>span classw> /span>span classmf>0.75/span>span classp>,/span>span classw> /span>span classs2>partnerPercentageFormatted/span>span classp>:/span>span classw> /span>span classs2>75%/span>span classp>,/span>span classw> /span>span classs2>buyRateLineItems/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Standard/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>180755.76/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>180,755.76/span>span classp>,/span>span classw> /span>span classs2>volumeRate/span>span classp>:/span>span classw> /span>span classmf>0.00015/span>span classp>,/span>span classw> /span>span classs2>volumeRateFormatted/span>span classp>:/span>span classw> /span>span classs2>0.015%/span>span classp>,/span>span classw> /span>span classs2>count/span>span classp>:/span>span classw> /span>span classmi>2485/span>span classp>,/span>span classw> /span>span classs2>countRate/span>span classp>:/span>span classw> /span>span classmf>0.02/span>span classp>,/span>span classw> /span>span classs2>countRateFormatted/span>span classp>:/span>span classw> /span>span classs2>0.02/span>span classp>,/span>span classw> /span>span classs2>rateSummary/span>span classp>:/span>span classw> /span>span classs2>180,755.76 @ 0.015%, 2,485 X 0.02/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>103.94/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>103.94/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Premium/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmf>19751.28/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>19,751.28/span>span classp>,/span>span classw> /span>span classs2>volumeRate/span>span classp>:/span>span classw> /span>span classmf>0.0012/span>span classp>,/span>span classw> /span>span classs2>volumeRateFormatted/span>span classp>:/span>span classw> /span>span classs2>0.12%/span>span classp>,/span>span classw> /span>span classs2>count/span>span classp>:/span>span classw> /span>span classmi>160/span>span classp>,/span>span classw> /span>span classs2>countRate/span>span classp>:/span>span classw> /span>span classmf>0.07/span>span classp>,/span>span classw> /span>span classs2>countRateFormatted/span>span classp>:/span>span classw> /span>span classs2>0.07/span>span classp>,/span>span classw> /span>span classs2>rateSummary/span>span classp>:/span>span classw> /span>span classs2>19,751.28 @ 0.12%, 160 X 0.07/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>58.62/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>58.62/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Debit/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmi>286486/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>286,486.00/span>span classp>,/span>span classw> /span>span classs2>volumeRate/span>span classp>:/span>span classw> /span>span classmf>0.00015/span>span classp>,/span>span classw> /span>span classs2>volumeRateFormatted/span>span classp>:/span>span classw> /span>span classs2>0.015%/span>span classp>,/span>span classw> /span>span classs2>count/span>span classp>:/span>span classw> /span>span classmi>6983/span>span classp>,/span>span classw> /span>span classs2>countRate/span>span classp>:/span>span classw> /span>span classmf>0.045/span>span classp>,/span>span classw> /span>span classs2>countRateFormatted/span>span classp>:/span>span classw> /span>span classs2>0.045/span>span classp>,/span>span classw> /span>span classs2>rateSummary/span>span classp>:/span>span classw> /span>span classs2>286,486.00 @ 0.015%, 6,983 X 0.045/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>400.19/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>400.19/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Batch Fees/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>volumeRate/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volumeRateFormatted/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>count/span>span classp>:/span>span classw> /span>span classmi>30/span>span classp>,/span>span classw> /span>span classs2>countRate/span>span classp>:/span>span classw> /span>span classmf>0.07/span>span classp>,/span>span classw> /span>span classs2>countRateFormatted/span>span classp>:/span>span classw> /span>span classs2>0.07/span>span classp>,/span>span classw> /span>span classs2>rateSummary/span>span classp>:/span>span classw> /span>span classs2>30 X 0.07/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>2.1/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>2.10/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Monthly/span>span classp>,/span>span classw> /span>span classs2>volume/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volumeFormatted/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>volumeRate/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>volumeRateFormatted/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>count/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw> /span>span classs2>countRate/span>span classp>:/span>span classw> /span>span classmi>5/span>span classp>,/span>span classw> /span>span classs2>countRateFormatted/span>span classp>:/span>span classw> /span>span classs2>5.00/span>span classp>,/span>span classw> /span>span classs2>rateSummary/span>span classp>:/span>span classw> /span>span classs2>1 X 5.00/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmi>5/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>5.00/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classs2>revenueDetails/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Total Acquiring Revenue/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>8058.21/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>8,058.21/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>WAB/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>8058.21/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>8,058.21/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>BlockChyp Fees/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>2430.02/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>2,430.02/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Interchange Fees/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>12351.28/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>12,351.28/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Misc Fees/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmi>20/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>20.00/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Other Passthrough Fees/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>1315.12/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>1,315.12/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw> /span>span classp>,/span>span classw> /span>span classs2>cardBrandCostDetails/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Total Card Brand Costs/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>7044.52/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>7,044.52/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>WAB/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>7044.52/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>7,044.52/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Passthrough Fees/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>6828.69/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>6,828.69/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Interchange Fees/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>6175.64/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>6,175.64/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>DISC/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>462.86/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>462.86/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>DS Commercial Electronic Submission Level/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>61.5/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>61.50/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.15/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.15/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.15/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>2.45%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>2.45%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>2.45%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>DS PSL - Retail Prepaid/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>1.25/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>1.25/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.16/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.16/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.16/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.12%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.12%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.12%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>DS PSL Retail DB/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>12.89/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>12.89/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.16/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.16/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.16/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.10%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.10%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.10%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>DS PSL Retail PR/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>180.69/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>180.69/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.74%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.74%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.74%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>DS PSL Retail Rewards/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>203.06/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>203.06/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.72%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.72%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.72%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>DS Retail (Premium Plus)/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>3.4699999999999998/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>3.47/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>2.25%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>2.25%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>2.25%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>AMEX/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>418.89/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>418.89/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>AM Prepaid Tier 1/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>0.48/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>0.48/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.35%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.35%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.35%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>AM Retail Tier 1/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>66.31/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>66.31/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.60%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.60%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.60%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>AM Retail Tier 2/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>191.15/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>191.15/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.95%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.95%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.95%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>AM Retail Tier 3/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>160.95/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>160.95/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>2.40%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>2.40%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>2.40%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VISA/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>3398.71/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>3,398.71/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS Business Card CP Debit/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>14.84/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>14.84/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.70%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.70%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.70%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS Business Purchase Retail Prepaid/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>10.41/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>10.41/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>2.15%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>2.15%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>2.15%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS Business Tr 5 Prod 2/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>130.08/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>130.08/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>2.25%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>2.25%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>2.25%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS Business Tr1 Prod 2/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>1.26/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>1.26/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.90%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.90%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.90%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS Business Tr2 Prod 2/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>56.54/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>56.54/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>2.05%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>2.05%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>2.05%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS Business Tr3 Prod 2/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>26.04/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>26.04/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>2.10%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>2.10%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>2.10%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS Business Tr4 Prod 2/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>50.54/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>50.54/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>2.20%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>2.20%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>2.20%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS CPS Retail Check Debit/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>192.9/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>192.90/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.15/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.15/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.15/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.80%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.80%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.80%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS CPS Retail Pp/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>81.9/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>81.90/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.15/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.15/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.15/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.15%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.15%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.15%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS CPS Small Ticket Debit/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>20.29/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>20.29/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.04/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.04/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.04/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.55%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.55%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.55%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS CPS Small Ticket Pp/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>11.3/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>11.30/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.05/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.05/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.05/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.60%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.60%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.60%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS CPS Small Ticket Regulated/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>158.76/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>158.76/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.22/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.22/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.22/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.05%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.05%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.05%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS Credit Voucher Non PT Credit/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>-2.16/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>-2.16/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.76%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.76%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.76%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS Electronic/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>1.6400000000000001/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>1.64/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.10%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.10%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.10%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS InterReg Corporate/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>1.34/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>1.34/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>2%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>2%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>2%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS InterReg Regulated Debit/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>0.23/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>0.23/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.22/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.22/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.22/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.05%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.05%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.05%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS InterReg Super Premium/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>0.4/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>0.40/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.97%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.97%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.97%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS Premium Card/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>2.13/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>2.13/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.80%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.80%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.80%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS US Corporate Card - Card Present/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>2.41/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>2.41/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>2.50%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>2.50%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>2.50%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS US Purchasing Card - Card Present/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>2.9/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>2.90/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>2.50%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>2.50%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>2.50%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS US Regulated Debit/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>794.27/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>794.27/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.22/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.22/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.22/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.05%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.05%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.05%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS VIN Product 2/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>460.15/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>460.15/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.65%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.65%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.65%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS VSP VIQ Product 2/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmi>1108/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>1,108.00/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>2.10%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>2.10%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>2.10%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS VT Product 2/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>125.74/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>125.74/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.51%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.51%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.51%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS VTR Product 2/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>103.82/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>103.82/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.65%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.65%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.65%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Visa VIQ Product 2/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>42.98/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>42.98/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>2.10%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>2.10%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>2.10%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>1895.18/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>1,895.18/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Business Level 1 Data Rate I/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>1.31/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>1.31/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>2.65%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>2.65%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>2.65%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Business Level 2 Data Rate I/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>14.96/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>14.96/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>2.80%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>2.80%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>2.80%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Business Level 3 Data Rate I/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>8.39/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>8.39/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>2.85%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>2.85%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>2.85%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Business Level 4 Data Rate I/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>1.09/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>1.09/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>2.95%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>2.95%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>2.95%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Business Level 5 Data Rate I/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>2.5300000000000002/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>2.53/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>3%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>3%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>3%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Commercial Rate 1 Large Market/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>35.29/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>35.29/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>2.70%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>2.70%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>2.70%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Consumer Credit Refund Group 4/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>-0.88/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>-0.88/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.75%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.75%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.75%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Consumer Rate 2-Card Present Core/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>4.52/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>4.52/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.10%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.10%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.10%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Corporate Data Rate 1/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>21.32/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>21.32/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>2.65%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>2.65%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>2.65%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Enhanced Merit III Base/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>177.26/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>177.26/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.80%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.80%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.80%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC High Value Merit III Base 1/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>134.42/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>134.42/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>2.30%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>2.30%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>2.30%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Merit 3 Prepaid/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>21.75/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>21.75/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.15/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.15/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.15/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.15%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.15%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.15%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Merit III Credit/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>52.81/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>52.81/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.65%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.65%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.65%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Merit III Debit/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>116.64/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>116.64/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.15/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.15/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.15/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.05%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.05%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.05%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Small Ticket Card Present/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>0.24/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>0.24/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.02/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.02/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.02/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.65%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.65%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.65%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC US Cons Regulated POS Debit w/Fraud Adj/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>468.18/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>468.18/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.22/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.22/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.22/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.05%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.05%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.05%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC World Elite Merit III/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmi>666/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>666.00/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>2.30%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>2.30%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>2.30%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC World Elite Small Ticket Card Present/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>0.84/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>0.84/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.02/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.02/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.02/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>2.30%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>2.30%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>2.30%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC World Merit III/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>168.41/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>168.41/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.90%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.90%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.90%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC World Small Ticket Card Present/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>0.1/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.02/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.02/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.02/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1.90%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1.90%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1.90%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Assessment Fees/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>653.05/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>653.05/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>184.34/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>184.34/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>ACQ Brand Volume/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>171.88/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>171.88/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.13%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.13%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.13%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>ACQ Brand Volume Above/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>12.46/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>12.46/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.14%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.14%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.14%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VISA/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>402.25/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>402.25/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>US Acquirer Service Fee - Credit/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>142.96/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>142.96/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.14%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.14%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.14%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>US Acquirer Service Fee - Debit/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>259.29/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>259.29/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.13%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.13%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.13%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>AMEX/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>32.6/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>32.60/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>US Assessment Fee/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>32.6/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>32.60/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.17%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.17%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.17%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>DISC/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>33.86/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>33.86/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Discover Acquirer Assessment Fee/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>33.86/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>33.86/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.14%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.14%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.14%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Non Passthrough Fees/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>215.83/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>215.83/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VISA/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>119.67/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>119.67/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>International ACQ - IAF/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>2.05/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>2.05/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.45%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.45%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.45%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>NAPF DOM Credit Auth/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>27.4/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>27.40/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.0195/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.0195/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.0195/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>NAPF DOM Credit Auth Reversal/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>0.02/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>0.02/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.0195/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.0195/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.0195/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>NAPF DOM Debit Auth/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>71.67/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>71.67/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.0155/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.0155/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.0155/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>NAPF DOM Debit Auth Reversal/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>0.11/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>0.11/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.0155/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.0155/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.0155/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>NAPF INTL Credit Auth/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>0.12/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>0.12/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.0395/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.0395/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.0395/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>NAPF INTL Debit Auth/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>0.36/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>0.36/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.0355/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.0355/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.0355/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>US Acquirer ISA Base Purchase/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>4.53/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>4.53/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>1%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>1%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>1%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS FANF CP/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmi>2/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>2.00/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>VS RAF Never Approve Domestic/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>0.3/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>0.30/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.10/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Visa Acquirer Credit Voucher Fee Credit/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>0.02/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>0.02/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.0195/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.0195/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.0195/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Visa Acquirer Credit Voucher Fee Debit/PPD/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>0.09/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>0.09/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.0155/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.0155/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.0155/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Visa BASE II Transmission Fee/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmi>11/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>11.00/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.0018/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.0018/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.0018/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>86.65/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>86.65/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>ACQ Program Support/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>3.48/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>3.48/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.85%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.85%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.85%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Cross Border - Domestic/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>2.46/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>2.46/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.60%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.60%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.60%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Acquirer License Fee/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>17.66/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>17.66/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.01%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.01%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.01%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>MC Safety Net Acquirer Fee/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>2.15/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>2.15/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.0007/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.0007/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.0007/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Mastercard Location Fee/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>1.25/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>1.25/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>NABU Auth/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>59.61/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>59.61/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.0195/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.0195/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.0195/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>NABU Returns/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>0.04/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>0.04/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.0195/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.0195/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.0195/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>DISC/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>6.31/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>6.31/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>DS Network Authorization Fee/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>5.57/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>5.57/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.019/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.019/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.019/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Discover Data Usage Fee/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>0.74/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>0.74/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.0025/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.0025/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.0025/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>AMEX/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>3.2/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>3.20/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classp>/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Amex Acquirer Transaction Fee/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmf>3.2/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>3.20/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0.02/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0.02/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0.02/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>min/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>avg/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classp>,/span>span classw> /span>span classs2>max/span>span classp>:/span>span classw> /span>span classs2>0%/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>},/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>description/span>span classp>:/span>span classw> /span>span classs2>Ignored Costs/span>span classp>,/span>span classw> /span>span classs2>expandable/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>negative/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>total/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw> /span>span classs2>totalFormatted/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>perTranFeeRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>transactionPercentageRange/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>detailLines/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw> /span>span classp>}/span>span classw> /span>span classp>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Partner/li>li>strong>Required Role:/strong> Partner API Access/li>/ul>p>This API allows partners to pull down the low level data used to compute a partner commission for a specific merchant statement./p>p>The code>statementId/code> is required and must be the id of a valid merchant invoice of type code>statement/code>./p>h2 idmerchant-credential-generation>Merchant Credential Generation/h2>blockquote>p>Merchant Credential Generation Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>merchant-credential-generation/span> -merchantIdspan classo>/span>span classs2><MERCHANT ID>/span> -deleteProtected -notesspan classo>/span>span classs2>merchant creds/span> -rolesspan classo>/span>span classs2>STDMERCHANT/span> -credTypespan classo>/span>span classs2>API/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>merchant-credential-generation/span> -merchantIdspan classo>/span>span classs2><MERCHANT ID>/span> -deleteProtected -notesspan classo>/span>span classs2>merchant creds/span> -rolesspan classo>/span>span classs2>STDMERCHANT/span> -credTypespan classo>/span>span classs2>API/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>merchantCredentialGenerationExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>MerchantCredentialGenerationRequest/span>span classp>{/span>span classx> /span>span classn>MerchantID/span>span classo>:/span>span classx> /span>span classs><MERCHANT ID>/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>MerchantCredentialGeneration/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>MerchantCredentialGenerationRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>MerchantCredentialGenerationRequest/span>span classp>{/span> span classn>MerchantId/span> span classp>/span> span classs><MERCHANT ID>/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>MerchantCredentialGenerationResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>MerchantCredentialGenerationAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.MerchantCredentialGenerationRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.MerchantCredentialGenerationResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>MerchantCredentialGenerationExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>MerchantCredentialGenerationRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>MerchantCredentialGenerationRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setMerchantId/span>span classo>(/span>span classs><MERCHANT ID>/span>span classo>);/span> span classc1>// Send the request/span> span classn>MerchantCredentialGenerationResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>merchantCredentialGeneration/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>merchantId/span> span classo>>/span> span classs1><MERCHANT ID>/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>merchantCredentialGeneration/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>merchantId: /span>span classs1><MERCHANT ID>/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>merchantCredentialGeneration/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>merchantId/span>span classp>:/span> span classs><MERCHANT ID>/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>merchant_credential_generation/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>merchantCredentialGeneration/span>span classp>({/span> span classna>merchantId/span>span classp>:/span> span classs1><MERCHANT ID>/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>MerchantCredentialGenerationRequest/span>span classp>();/span>span classnx>request/span>span classp>./span>span classnx>merchantId/span> span classo>/span> span classs1><MERCHANT ID>/span>span classp>;/span>span classnx>client/span>span classp>./span>span classnx>merchantCredentialGeneration/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>MerchantCredentialGenerationResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>merchantId/span>span classp>/span> span classo>/span> span classs><MERCHANT ID>/span> span classp>/span>span classn>client/span> span classnf>merchantCredentialGenerationWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>merchantId/span>span classp>/span> span classo>/span> span classs><MERCHANT ID>/span> span classn>client/span>span classo>./span>span classnf>merchantCredentialGeneration/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>merchant_credential_generation_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>MerchantCredentialGenerationRequest/span>span classp>{/span> span classn>merchant_id/span>span classp>:/span> span classs><MERCHANT ID>/span>span classnf>.to_string/span>span classp>(),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.merchant_credential_generation/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>merchant_credential_generation_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>apiKey/span>span classp>:/span>span classs2>ESHROE5LR7ZQL5ZP7JZXERTL5A/span>span classp>,/span>span classw> /span>span classs2>bearerToken/span>span classp>:/span>span classs2>7090348321454ed7b53eefc7fa18f0a43e72ffc9248ae12b5460c7e9a981c968/span>span classp>,/span>span classw> /span>span classs2>signingKey/span>span classp>:/span>span classs2>71db9b0587e7e931c16fb3be4767e406e74a147f59daa2f4c9279e9f7bcd8ed7/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Partner/li>li>strong>Required Role:/strong> Partner API Access/li>/ul>p>This API allows partners to generate API credentials for a merchant./p>p>The code>merchantId/code> is required and must be the id of a valid merchant./p>p>Credentials are not delete protected by default. Pass in code>deleteProtected/code> to enable delete protection./p>p>The optional code>notes/code> field will populate the notes in the credentials./p>p>By default no roles will be assigned unless valid, comma-delimited, role codes are passed in the code>roles/code> field./p>h2 idsubmit-application>Submit Application/h2>blockquote>p>Submit Application Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>submit-application/span> -jsonFilespan classo>/span>span classs2>application.json/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>submit-application/span> -jsonFilespan classo>/span>span classs2>application.json/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/v2/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>submitApplicationExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>SubmitApplicationRequest/span>span classp>{}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>SubmitApplication/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Success/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>Success/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>SubmitApplicationRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>SubmitApplicationRequest/span>span classp>{/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>Acknowledgement/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>SubmitApplicationAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.SubmitApplicationRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.Acknowledgement/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>SubmitApplicationExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>SubmitApplicationRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>SubmitApplicationRequest/span>span classo>();/span> span classc1>// Send the request/span> span classn>Acknowledgement/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>submitApplication/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>submitApplication/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>submitApplication/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>submit_application/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>submitApplication/span>span classp>({/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code>span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span>span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>SubmitApplicationRequest/span>span classp>();/span>span classnx>client/span>span classp>./span>span classnx>submitApplication/span>span classp>(/span>span classnx>request/span>span classp>)/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>Acknowledgement/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>});/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classp>/span>span classn>client/span> span classnf>submitApplicationWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@success/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@Success/span>span classp>);/span> span classp>}/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>client/span>span classo>./span>span classnf>submitApplication/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>success/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>Success/span>span classp>)/span> span classp>}/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classn>blockchyp/span>span classp>;/span>span classk>use/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classp>;/span>span classk>fn/span> span classnf>submit_application_example/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classn>Error/span>span classo>>>/span> span classp>{/span> span classc>// sample credentials/span> span classk>let/span> span classn>creds/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classc>// instantiate the client/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classn>request/span> span classo>/span> span classnn>blockchyp/span>span classp>::/span>span classn>SubmitApplicationRequest/span>span classp>{/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.submit_application/span>span classp>(/span>span classo>&/span>span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classnf>Err/span>span classp>(/span>span classn>e/span>span classp>)/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.success/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>Success/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classk>->/span> span classn>Result/span>span classo>span classp>(),/span> span classnb>Box/span>span classo>span classn>dyn/span> span classnn>std/span>span classp>::/span>span classnn>error/span>span classp>::/span>span classn>Error/span>span classo>>>/span> span classp>{/span> span classnf>submit_application_example/span>span classp>()/span>span classo>?/span>span classp>;/span> span classnd>println!/span>span classp>(/span>span classs>Example completed successfully!/span>span classp>);/span> span classnf>Ok/span>span classp>(())/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>ul>li>strong>API Credential Types:/strong> Partner/li>li>strong>Required Role:/strong> INVITE MERCHANT/li>/ul>p>This is a partner level API that can be used to submit applications to add new merchant accounts. The application requires a significant amount of detailed information about the merchant and their business. Rather than providing an exhaustive list of required fields, we recommend submitting as much information as possible in your initial request. /p>p>If any required fields are missing or if there are any validation errors, the API will return specific error messages indicating which fields need to be addressed. Simply review these validation errors, fill in the missing information or correct any errors, and resubmit the application./p>p>Key areas of information include:- Business details (name, type, tax information)- Contact information- Address information (physical and mailing)- Owner details- Bank account information- Transaction volume estimates- Operational settings (timezone, batch close time, etc.)/p>p>strong>Note:/strong> Some fields may be conditionally required based on the values of other fields. The validation process will guide you through ensuring all necessary information is provided./p>h1 idauthorization-responses>Authorization Responses/h1>p>When you execute authorization requests via terminals or directly via the gateway,BlockChyp returns just about everything except PCI scoped information./p>p>While much of this information is self-documenting, we thought it mightbe helpful to provide a bit more detail on the fields returned by a transaction./p>p>In this section, we'll show a typical sample response and provide a detaileddocumentation for all the fields./p>blockquote>p>Sample response for an EMV contact transaction:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>approved/span>span classp>,/span>span classw> /span>span classs2>approved/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>authCode/span>span classp>:/span>span classw> /span>span classs2>688149/span>span classp>,/span>span classw> /span>span classs2>transactionId/span>span classp>:/span>span classw> /span>span classs2>DRJSIVMOHAI6VKFSAJBKYEIAAQ/span>span classp>,/span>span classw> /span>span classs2>transactionRef/span>span classp>:/span>span classw> /span>span classs2>30188518136/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>charge/span>span classp>,/span>span classw> /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classs2>2020-05-04T18:50:22Z/span>span classp>,/span>span classw> /span>span classs2>tickBlock/span>span classp>:/span>span classw> /span>span classs2>0003d28eb5d1b62e9b8d4337a9a62d3403ab0fe419839048042c380f584983a5/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>partialAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>altCurrency/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>fsaAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>currencyCode/span>span classp>:/span>span classw> /span>span classs2>USD/span>span classp>,/span>span classw> /span>span classs2>requestedAmount/span>span classp>:/span>span classw> /span>span classs2>103.81/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>103.81/span>span classp>,/span>span classw> /span>span classs2>remainingBalance/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>tipAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>taxAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>requestedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>authorizedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>CHIP/span>span classp>,/span>span classw> /span>span classs2>paymentType/span>span classp>:/span>span classw> /span>span classs2>VISA/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************0010/span>span classp>,/span>span classw> /span>span classs2>cardHolder/span>span classp>:/span>span classw> /span>span classs2>UAT USA/Test Card 04/span>span classp>,/span>span classw> /span>span classs2>avsResponse/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>receiptSuggestions/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>aid/span>span classp>:/span>span classw> /span>span classs2>A0000000031010/span>span classp>,/span>span classw> /span>span classs2>arqc/span>span classp>:/span>span classw> /span>span classs2>A84402A0BC10D1F5/span>span classp>,/span>span classw> /span>span classs2>iad/span>span classp>:/span>span classw> /span>span classs2>06010A03A0B800/span>span classp>,/span>span classw> /span>span classs2>tvr/span>span classp>:/span>span classw> /span>span classs2>8000008800/span>span classp>,/span>span classw> /span>span classs2>tsi/span>span classp>:/span>span classw> /span>span classs2>6800/span>span classp>,/span>span classw> /span>span classs2>merchantName/span>span classp>:/span>span classw> /span>span classs2>CLI Regression Test/span>span classp>,/span>span classw> /span>span classs2>applicationLabel/span>span classp>:/span>span classw> /span>span classs2>VISA CREDIT/span>span classp>,/span>span classw> /span>span classs2>requestSignature/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************0010/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>103.81/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>charge/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>CHIP/span>span classp>,/span>span classw> /span>span classs2>cashBackAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>surcharge/span>span classp>:/span>span classw> /span>span classs2>3.81/span>span classp>,/span>span classw> /span>span classs2>cashDiscount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>customer/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>id/span>span classp>:/span>span classw> /span>span classs2>P7UV23UOEII6VJCUAJBKYEIAAI/span>span classp>,/span>span classw> /span>span classs2>customerRef/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>firstName/span>span classp>:/span>span classw> /span>span classs2>Peter/span>span classp>,/span>span classw> /span>span classs2>lastName/span>span classp>:/span>span classw> /span>span classs2>Gregory/span>span classp>,/span>span classw> /span>span classs2>companyName/span>span classp>:/span>span classw> /span>span classs2>Raviga Capital/span>span classp>,/span>span classw> /span>span classs2>emailAddress/span>span classp>:/span>span classw> /span>span classs2>peter@raviga.capital/span>span classp>,/span>span classw> /span>span classs2>smsNumber/span>span classp>:/span>span classw> /span>span classs2>9136488888/span>span classp>,/span>span classw> /span>span classs2>paymentMethods/span>span classp>:/span>span classw> /span>span classkc>null/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>whiteListedCard/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>storeAndForward/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>table>thead>tr>th>Field/th>th>Description/th>/tr>/thead>tbody>tr>td>strong>success/strong>/td>td>Returns true if no unexpected error occurred processing the transaction. This doesn't mean the transaction was approved; just that no unexpected error occurred. If this value is false, it usually indicates network trouble, a bad configuration, or invalid parameters./td>/tr>tr>td>strong>error/strong>/td>td>If success is false, this field will include some text describing the error./td>/tr>tr>td>strong>responseDescription/strong>/td>td>A narrative description of the response. There are no hard coded values for this field, so don't hard code any string tests when using this field./td>/tr>tr>td>strong>approved/strong>/td>td>Returns true if the transaction was approved./td>/tr>tr>td>strong>authCode/strong>/td>td>Authorization code returned by the payment card network./td>/tr>tr>td>strong>transactionId/strong>/td>td>BlockChyp assigned ID for the transaction. You'll need this for capturing preauths, voids, or giving refunds. You should store it in your transaction records./td>/tr>tr>td>strong>transactionRef/strong>/td>td>If you passed in a code>transactionRef/code> with the authorization request (which you should definitely do), it will be echoed back here./td>/tr>tr>td>strong>transactionType/strong>/td>td>Echoes back the transaction type. For a terminal transaction, will be code>charge/code>, code>preauth/code>, code>enroll/code>, or code>refund/code>./td>/tr>tr>td>strong>timestamp/strong>/td>td>The date and time BlockChyp processed the transaction in ISO-8601 format. Always returned in UTC./td>/tr>tr>td>strong>tickBlock/strong>/td>td>The most recent clockchain hash when the transaction was processed. You don't really need to worry about this unless you're dealing with low level blockchain stuff./td>/tr>tr>td>strong>test/strong>/td>td>A boolean flag indicating that this was a test transaction./td>/tr>tr>td>strong>partialAuth/strong>/td>td>Flag indicates that the transaction was a partial auth, meaning that the transaction was authorized for an amount less than the requested amount. If your system supports gift cards, you'll need to check for this./td>/tr>tr>td>strong>altCurrency/strong>/td>td>A flag indicating that the transaction was paid for in a different currency than the request./td>/tr>tr>td>strong>fasAuth/strong>/td>td>A flag indicating that the customer presented an FSA or HSA card for payment./td>/tr>tr>td>strong>currencyCode/strong>/td>td>The three character ISO code for the currency used for the transaction. Since BlockChyp is currently US only, this will almost always be code>USD/code>./td>/tr>tr>td>strong>requestedAmount/strong>/td>td>Amount requested for the transaction./td>/tr>tr>td>strong>authorizedAmount/strong>/td>td>Amount authorized for the transaction. This will usually be the same as code>requestedAmount/code> unless the transaction was declined or a partial authorization./td>/tr>tr>td>strong>entryMethod/strong>/td>td>Indicates the entry method. For Contact EMV, this will be code>CHIP/code>./td>/tr>tr>td>strong>paymentType/strong>/td>td>Indicates the card association or card type. code>VISA/code>, code>MC/code>, code>DEBIT/code>, etc./td>/tr>tr>td>strong>maskedPan/strong>/td>td>The card number with all digits other than the last four masked out./td>/tr>tr>td>strong>cardHolder/strong>/td>td>The card holder's name./td>/tr>tr>td>strong>receiptSuggestions/strong>/td>td>A collection of fields that we strongly recommend you put on all printed receipts. If you put all these fields on your receipts, 90% of the stuff you'll need to do to ensure you're following all the EMV rules is done./td>/tr>tr>td>strong>aid/strong>/td>td>Application Identifier. Taken from EMV tag code>9F06/code>, this identifies the app on the chip selected by the terminal. Required on all EMV receipts./td>/tr>tr>td>strong>arqc/strong>/td>td>Application Cryptogram. Taken from EMV tag code>9F26/code>, this is the unique transaction signature generated by the chip. This is not required on receipts, but we recommend it because this value is real proof that a chip was present./td>/tr>tr>td>strong>iad/strong>/td>td>Issuer Application Data. Taken from EMV tag code>9F10/code>, this is pass through information generated by the card issuer's chip application. Purpose and content vary by card issuer./td>/tr>tr>td>strong>tvr/strong>/td>td>Terminal Verification Response. Taken from EMV tag code>95/code>, this is a bitfield that documents what steps the terminal took to verify the card./td>/tr>tr>td>strong>tsi/strong>/td>td>Transaction Status Information. Taken from EMV tag code>9B/code>, this is a bitfield that documents all the risk management steps performed to authorize the transaction, whether done by the chip or the terminal./td>/tr>tr>td>strong>merchantName/strong>/td>td>Merchant's name as it should appear on the receipt./td>/tr>tr>td>strong>applicationLabel/strong>/td>td>The human readable application name that goes along with the AID./td>/tr>tr>td>strong>requestSignature/strong>/td>td>This will be true if the transaction requires a written signature and the terminal didn't capture it. It's under receipt suggestions since it means you'll need to put a signature line on the printed receipt./td>/tr>tr>td>strong>cashBackAmount/strong>/td>td>Indicates the amount of cash back the customer requested if this was a debit transaction/td>/tr>tr>td>strong>surcharge/strong>/td>td>For cash discount and surcharge enabled accounts, returns the surcharge applied to the transaction./td>/tr>tr>td>strong>cashDiscount/strong>/td>td>If payment method was a debit card and the merchant is using cash discounting, this will return the offsetting cash discount./td>/tr>tr>td>strong>customer/strong>/td>td>If a customer was created as part of the transaction or if the presented card was previously associated with a customer record, the full customer record is returned./td>/tr>tr>td>strong>whiteListedCard/strong>/td>td>This field returns detailed card information if the card belongs to a white listed BIN. This has to be configured on a per merchant basis. This allows developers to use the terminal as a dumb terminal and process the payment on their own. This is typically only used for corporate gift card systems./td>/tr>tr>td>strong>storeAndForward/strong>/td>td>A flag indicating that the transaction was conditionally authorized offline as a store and forward transaction./td>/tr>/tbody>/table>h1 idworking-with-signatures>Working With Signatures/h1>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -typespan classo>/span>span classs2>charge/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -amountspan classo>/span>span classs2>25.00/span>Windows: ./blockchyp.exe -test -typespan classo>/span>span classs2>charge/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -amountspan classo>/span>span classs2>25.00/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>chargeExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>AuthorizationRequest/span>span classp>{/span>span classx> /span>span classn>Test/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classn>TerminalName/span>span classo>:/span>span classx> /span>span classs>Test Terminal/span>span classp>,/span>span classx> /span>span classn>Amount/span>span classo>:/span>span classx> /span>span classs>55.00/span>span classp>,/span>span classx> /span>span classn>SigFormat/span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>SignatureFormatPNG/span>span classp>,/span>span classx> /span>span classn>SigWidth/span>span classo>:/span>span classx> /span>span classm>400/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>Charge/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Approved/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>approved/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>AuthorizationRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>AuthorizationRequest/span>span classp>{/span> span classn>Test/span> span classp>/span> span classk>true/span>span classp>,/span> span classn>TerminalName/span> span classp>/span> span classs>Test Terminal/span>span classp>,/span> span classn>Amount/span> span classp>/span> span classs>55.00/span>span classp>,/span> span classn>SigFormat/span> span classp>/span> span classn>SignatureFormat/span>span classp>./span>span classn>PNG/span>span classp>,/span> span classn>SigWidth/span> span classp>/span> span classm>400/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>AuthorizationResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>ChargeAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.AuthorizationRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.AuthorizationResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>ChargeExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>AuthorizationRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>AuthorizationRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTest/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setTerminalName/span>span classo>(/span>span classs>Test Terminal/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setAmount/span>span classo>(/span>span classs>55.00/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setSigFormat/span>span classo>(/span>span classn>SignatureFormat/span>span classo>./span>span classna>PNG/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setSigWidth/span>span classo>(/span>span classmi>400/span>span classo>);/span> span classc1>// Send the request/span> span classn>AuthorizationResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>charge/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>test/span> span classo>>/span> span classkc>true/span>span classp>,/span> span classs1>terminalName/span> span classo>>/span> span classs1>Test Terminal/span>span classp>,/span> span classs1>amount/span> span classo>>/span> span classs1>55.00/span>span classp>,/span> span classs1>sigFormat/span> span classo>>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>SIGNATURE_FORMAT_PNG/span>span classp>,/span> span classs1>sigWidth/span> span classo>>/span> span classmi>400/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>charge/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classs2>test/span>span classp>:/span> span classkp>true/span>span classp>,/span> span classs2>terminalName/span>span classp>:/span> span classs1>Test Terminal/span>span classp>,/span> span classs2>amount/span>span classp>:/span> span classs1>55.00/span> span classs2>sigFormat/span>span classp>:/span> span classno>SignatureFormat/span>span classo>::/span>span classno>PNG/span>span classp>,/span> span classs2>sigWidth/span>span classp>:/span> span classmi>400/span>span classp>,/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>charge/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>test/span>span classp>:/span> span classbp>True/span>span classp>,/span> span classs>terminalName/span>span classp>:/span> span classs>Test Terminal/span>span classp>,/span> span classs>amount/span>span classp>:/span> span classs>55.00/span>span classp>,/span> span classs>sigFormat/span>span classp>:/span> span classn>blockchyp/span>span classo>./span>span classn>SignatureFormat/span>span classo>./span>span classn>PNG/span>span classp>,/span> span classs>sigWidth/span>span classp>:/span> span classmi>400/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>charge/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code> span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>BlockChyp/span>span classp>);/span> span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs2>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs2>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs2>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span> span classp>});/span> span classc1>// setup request object/span> span classnx>request/span> span classo>/span> span classp>{/span> span classna>test/span>span classp>:/span> span classkc>true/span>span classp>,/span> span classna>terminalName/span>span classp>:/span> span classs1>Test Terminal/span>span classp>,/span> span classna>amount/span>span classp>:/span> span classs1>55.00/span>span classp>,/span> span classna>sigFormat/span>span classp>:/span> span classnx>SignatureFormat/span>span classp>./span>span classnx>PNG/span>span classp>,/span> span classna>sigWidth/span>span classp>:/span> span classmi>400/span>span classp>,/span> span classp>}/span> span classnx>response/span> span classo>/span> span classnx>client/span>span classp>./span>span classnx>charge/span>span classp>(/span>span classnx>request/span>span classp>)/span> span classc1>// view the result/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs2>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>))/span>/code>/pre>pre classhighlight typescript tab-typescript>code> span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span> span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span> span classp>});/span> span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>AuthorizationRequest/span>span classp>();/span> span classnx>request/span>span classp>./span>span classnx>test/span> span classo>/span> span classkc>true/span>span classp>;/span> span classnx>request/span>span classp>./span>span classnx>terminalName/span> span classo>/span> span classs1>Test Terminal/span>span classp>;/span> span classnx>request/span>span classp>./span>span classnx>amount/span> span classo>/span> span classs1>55.00/span>span classp>;/span> span classnx>request/span>span classp>./span>span classnx>sigFormat/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>SignatureFormat/span>span classp>./span>span classnx>PNG/span>span classp>;/span> span classnx>request/span>span classp>./span>span classnx>sigWidth/span> span classo>/span> span classmi>400/span>span classp>;/span> span classnx>client/span>span classp>./span>span classnx>charge/span>span classp>(/span>span classnx>request/span>span classp>)/span> span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>AuthorizationResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>})/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>@test/span>span classp>/span> span classo>/span> span classnb>@YES/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>@terminalName/span>span classp>/span> span classo>/span> span classs>@Test Terminal/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>@amount/span>span classp>/span> span classo>/span> span classs>@55.00/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>@sigFormat/span>span classp>/span> span classo>/span> span classn>SIGNATURE_FORMAT_PNG/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>@sigWidth/span>span classp>/span> span classo>/span> span classmi>@400/span>span classp>;/span> span classp>/span>span classn>client/span> span classnf>chargeWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@approved/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@approved/span>span classp>);/span> span classp>}/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@authCode/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@authCode/span>span classp>)/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@authorizedAmount/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@authorizedAmount/span>span classp>)/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classkc>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>request/span>span classp>/span>span classs>amount/span>span classp>/span> span classo>/span> span classs>55.00/span> span classn>request/span>span classp>/span>span classs>sigFormat/span>span classp>/span> span classo>/span> span classkt>SIGNATURE_FORMAT_PNG/span> span classn>request/span>span classp>/span>span classs>sigWidth/span>span classp>/span> span classo>/span> span classmi>400/span> span classn>client/span>span classo>./span>span classnf>charge/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>approved/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>approved/span>span classp>)/span> span classp>}/span> span classkt>NSLog/span>span classp>(/span>span classs>authCode/span> span classo>+/span> span classs>: /span> span classo>+/span> span classp>(/span>span classn>response/span>span classp>/span>span classs>authCode/span>span classp>/span> span classk>as?/span> span classkt>String/span>span classp>)/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classkt>NSLog/span>span classp>(/span>span classs>authorizedAmount/span> span classo>+/span> span classs>: /span> span classo>+/span> span classp>(/span>span classn>response/span>span classp>/span>span classs>authorizedAmount/span>span classp>/span> span classk>as?/span> span classkt>String/span>span classp>)/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classp>::/span>span classnn>blockchyp/span>span classp>::/span>span classo>*/span>span classp>;/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classp>{/span> span classk>let/span> span classn>creds/span> span classo>/span> span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classk>mut/span> span classn>request/span> span classo>/span> span classn>AuthorizationRequest/span>span classp>{/span> span classn>test/span>span classp>:/span> span classk>true/span>span classp>,/span> span classn>terminal_name/span>span classp>:/span> span classs>Test Terminal/span>span classnf>.to_string/span>span classp>(),/span> span classn>amount/span>span classp>:/span> span classs>55.00/span>span classnf>.to_string/span>span classp>(),/span> span classn>sig_format/span>span classp>:/span> span classnn>SignatureFormat/span>span classp>::/span>span classn>PNG/span>span classp>,/span> span classn>sig_width/span>span classp>:/span> span classmi>400/span>span classp>,/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.charge/span>span classp>(/span>span classo>&/span>span classk>mut/span> span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.approved/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>approved/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>approved/span>span classp>,/span>span classw> /span>span classs2>approved/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>authCode/span>span classp>:/span>span classw> /span>span classs2>052509/span>span classp>,/span>span classw> /span>span classs2>transactionId/span>span classp>:/span>span classw> /span>span classs2>KJ3DPHULBAI6VOTSNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>transactionRef/span>span classp>:/span>span classw> /span>span classs2>04781125618/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>charge/span>span classp>,/span>span classw> /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classs2>2020-04-30T18:28:10Z/span>span classp>,/span>span classw> /span>span classs2>tickBlock/span>span classp>:/span>span classw> /span>span classs2>009991a8ac7b6a4420760e1e14e1689c88be2a610a033d6908c1b04b5c00f9da/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>partialAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>altCurrency/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>fsaAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>currencyCode/span>span classp>:/span>span classw> /span>span classs2>USD/span>span classp>,/span>span classw> /span>span classs2>requestedAmount/span>span classp>:/span>span classw> /span>span classs2>25.00/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>25.00/span>span classp>,/span>span classw> /span>span classs2>remainingBalance/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>tipAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>taxAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>requestedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>authorizedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>CHIP/span>span classp>,/span>span classw> /span>span classs2>paymentType/span>span classp>:/span>span classw> /span>span classs2>VISA/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************0010/span>span classp>,/span>span classw> /span>span classs2>cardHolder/span>span classp>:/span>span classw> /span>span classs2>UAT USA/Test Card 04/span>span classp>,/span>span classw> /span>span classs2>avsResponse/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classerr>///span>span classw> /span>span classerr>sig/span>span classw> /span>span classerr>file/span>span classw> /span>span classerr>returned/span>span classw> /span>span classerr>in/span>span classw> /span>span classerr>hex/span>span classw> /span>span classerr>if/span>span classw> /span>span classerr>sigFile/span>span classw> /span>span classerr>output/span>span classw> /span>span classerr>not/span>span classw> /span>span classerr>specified/span>span classw> /span>span classs2>sigFile/span>span classp>:/span>span classs2>89504e470d0a1a0a0000000d49484452000.../span>span classp>,/span>span classw> /span>span classs2>receiptSuggestions/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>aid/span>span classp>:/span>span classw> /span>span classs2>A0000000031010/span>span classp>,/span>span classw> /span>span classs2>arqc/span>span classp>:/span>span classw> /span>span classs2>BDFD1A64620D9382/span>span classp>,/span>span classw> /span>span classs2>iad/span>span classp>:/span>span classw> /span>span classs2>06010A03A0B800/span>span classp>,/span>span classw> /span>span classs2>tvr/span>span classp>:/span>span classw> /span>span classs2>8000008800/span>span classp>,/span>span classw> /span>span classs2>tsi/span>span classp>:/span>span classw> /span>span classs2>6800/span>span classp>,/span>span classw> /span>span classs2>merchantName/span>span classp>:/span>span classw> /span>span classs2>Test Merchant/span>span classp>,/span>span classw> /span>span classs2>applicationLabel/span>span classp>:/span>span classw> /span>span classs2>VISA CREDIT/span>span classp>,/span>span classw> /span>span classs2>requestSignature/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************0010/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>25.00/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>charge/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>CHIP/span>span classp>,/span>span classw> /span>span classs2>cashBackAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>surcharge/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>cashDiscount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>customer/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>whiteListedCard/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>storeAndForward/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>p>Believe it or not, we still live in a world where people sometimes have to signtheir names. This might be in the context of a payment transaction or it couldbe in the context of signing an agreement./p>p>No matter the context, written signatures in BlockChyp are always handled thesame way./p>p>strong>When Are Signatures Required?/strong>/p>p>It used to be always in the days before EMV. These days it's more complicated.For Terms and Conditions requests, the answer is always unless you specificallydisable signature capture. (Not common.)/p>p>For terminal transactions, it depends on the outcome of a conversation betweenthe card and the terminal. If the card and the terminal can't use some otherform of customer verification (like a PIN code), the terminal will usuallyprompt for a signature. Mag stripe cards (other than gift or EBT) will alwaysprompt for a signature./p>p>strong>Disabling Signatures/strong>/p>p>You can disable signatures in the merchant profile or you can pass in acode>disableSignature/code> flag with a transaction. This will bypass electronicsignature capture. Bear in mind that the signature CVM requirement doesn'tgo away just because you pass in the flag. For payment transactions, you'llstill usually need to capture a signature. Check the code>requestSignature/code> flagunder code>receiptSuggestions/code> to determine if you need to get a written signatureon the receipt. This will ensure your receipts are always compliant andyou won't have to worry about the rules./p>p>strong>Default Behavior/strong>/p>p>Signatures are typically only needed during audits or fraud investigations andfor that reason we don't burden you with storing them by default. We store thesignatures in our system for all payment and Terms & Conditions transactions.If you need to view or audit a signature, just bring up the T&C Log entry ortransaction in the BlockChyp dashboard and you'll be able to inspect it./p>p>The only exception are signatures captured with the direct Capture Signature API.This is considered a low level terminal API so you'll have to do some extrawork to get your hands on these signatures./p>p>strong>Getting Signature Images/strong>/p>p>If for some reason you actually want signature imagesyou can pass in a few extra parameters with your request and get signatures backin a common raster format. BlockChyp can return the image as hexadecimal encodedbinary as part of the response (see the example response) or you can specifya file location the image should be exported to./p>ul>li>strong>sigFormat/strong>: The file format you'd like that signature in. Currently supported options are PNG or JPEG./li>li>strong>sigWidth/strong>: Max width of the image in pixels. If provided, we'll scale the underlying vector image to your preferred max width while preserving the aspect ratio./li>li>strong>sigFile/strong>: An optional file location to which the image file will be written./li>/ul>h1 idgift-cards>Gift Cards/h1>p>The BlockChyp gift card system is quite a bit different from conventional gift cards. Conventional gift cards, just like credit cards, typically rely on 16 digit primary account numbers. These numbers are relatively easy to guess via brute force, which makes them vulnerable to a host of security problems. But unlike conventional credit card numbers, gift cards aren’t protected by PCI and often implemented by white listing gift card BIN ranges. They’re usually the most insecure part of any payment system./p>p>BlockChyp gift cards do have 16 digit numbers printed on them for familiarity and convenience, but these numbers are for identification purposes only. Under the hood every BlockChyp gift card has a unique set of P256 elliptic curve keys./p>p>The elliptic curve keys are used to open a new blockchain when new gift cards are activated and, as the card is redeemed and recharged, the keys are used to sign transactions. This means that shared secrets (i.e. primary account numbers) are never transmitted over the network with a BlockChyp gift card transaction. The transaction could be intercepted or sent in the clear and not compromise the gift card./p>p>We’ve gone through a lot of trouble to insulate developers from dealing with blockchain details. BlockChyp gift card transactions are like any other transaction with the exception of how gift cards are identified. Authorization requests for gift card transactions return the elliptic curve public key in the publicKey field. If you need to keep track of gift cards in your SaaS or point-of-sale systems, use the public key. A remaining balance is also returned with every gift card authorization./p>p>Although you don’t have to understand blockchain technology to work with BlockChyp gift cards, the merchant and developer dashboards expose methods of browsing and viewing the raw blockchain for the curious./p>h2 idthird-party-gift-cards>Third Party Gift Cards/h2>p>For merchants with existing gift card liability, these gift cards can be easily imported into BlockChyp. Simply provide your liability report to your BlockChyp representative. BlockChyp will review the liability data and import the gift cards into your BlockChyp account./p>p>Third party gift cards are redeemed just like BlockChyp gift cards. Simply swipe them on the terminal at the present card prompt./p>h2 idbin-range-white-listing>BIN Range White Listing/h2>p>In the event that developers need to process certain card types outside of BlockChyp, it is possible to white list BIN ranges and have the raw card data returned. Configuring a merchant account for white listing does require a security review by BlockChyp. If you need to white list a BIN range, contact BlockChyp support to complete the setup./p>h1 idebt>EBT/h1>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -typespan classo>/span>span classs2>charge/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -amountspan classo>/span>span classs2>25.00/span> -ebtWindows: ./blockchyp.exe -test -typespan classo>/span>span classs2>charge/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -amountspan classo>/span>span classs2>25.00/span> -ebt/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>chargeExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>AuthorizationRequest/span>span classp>{/span>span classx> /span>span classn>Test/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classn>TerminalName/span>span classo>:/span>span classx> /span>span classs>Test Terminal/span>span classp>,/span>span classx> /span>span classn>Amount/span>span classo>:/span>span classx> /span>span classs>55.00/span>span classp>,/span>span classx> /span>span classn>CardType/span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>CardTypeEBT/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>Charge/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Approved/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>approved/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>AuthorizationRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>AuthorizationRequest/span>span classp>{/span> span classn>Test/span> span classp>/span> span classk>true/span>span classp>,/span> span classn>TerminalName/span> span classp>/span> span classs>Test Terminal/span>span classp>,/span> span classn>Amount/span> span classp>/span> span classs>55.00/span>span classp>,/span> span classn>CardType/span> span classp>/span> span classn>CardType/span>span classp>./span>span classn>EBT/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>AuthorizationResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>ChargeAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.AuthorizationRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.AuthorizationResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>ChargeExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>AuthorizationRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>AuthorizationRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTest/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setTerminalName/span>span classo>(/span>span classs>Test Terminal/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setAmount/span>span classo>(/span>span classs>55.00/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setCardType/span>span classo>(/span>span classn>CardType/span>span classo>./span>span classna>EBT/span>span classo>);/span> span classc1>// Send the request/span> span classn>AuthorizationResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>charge/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>test/span> span classo>>/span> span classkc>true/span>span classp>,/span> span classs1>terminalName/span> span classo>>/span> span classs1>Test Terminal/span>span classp>,/span> span classs1>amount/span> span classo>>/span> span classs1>55.00/span>span classp>,/span> span classs1>cardType/span> span classo>>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>CARD_TYPE_EBT/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>charge/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classs2>test/span>span classp>:/span> span classkp>true/span>span classp>,/span> span classs2>terminalName/span>span classp>:/span> span classs1>Test Terminal/span>span classp>,/span> span classs2>amount/span>span classp>:/span> span classs1>55.00/span>span classp>,/span> span classs2>cardType/span>span classp>:/span> span classno>CardType/span>span classo>::/span>span classno>EBT/span>span classp>,/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>charge/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>test/span>span classp>:/span> span classbp>True/span>span classp>,/span> span classs>terminalName/span>span classp>:/span> span classs>Test Terminal/span>span classp>,/span> span classs>amount/span>span classp>:/span> span classs>55.00/span>span classp>,/span> span classs>cardType/span>span classp>:/span> span classn>blockchyp/span>span classo>./span>span classn>CardType/span>span classo>./span>span classn>EBT/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>charge/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code> span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>BlockChyp/span>span classp>);/span> span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs2>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs2>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs2>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span> span classp>});/span> span classc1>// setup request object/span> span classnx>request/span> span classo>/span> span classp>{/span> span classna>test/span>span classp>:/span> span classkc>true/span>span classp>,/span> span classna>terminalName/span>span classp>:/span> span classs1>Test Terminal/span>span classp>,/span> span classna>amount/span>span classp>:/span> span classs1>55.00/span>span classp>,/span> span classna>cardType/span>span classp>:/span> span classnx>CardType/span>span classp>./span>span classnx>EBT/span>span classp>,/span> span classp>}/span> span classnx>response/span> span classo>/span> span classnx>client/span>span classp>./span>span classnx>charge/span>span classp>(/span>span classnx>request/span>span classp>)/span> span classc1>// view the result/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs2>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>))/span>/code>/pre>pre classhighlight typescript tab-typescript>code> span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span> span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span> span classp>});/span> span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>AuthorizationRequest/span>span classp>();/span> span classnx>request/span>span classp>./span>span classnx>test/span> span classo>/span> span classkc>true/span>span classp>;/span> span classnx>request/span>span classp>./span>span classnx>terminalName/span> span classo>/span> span classs1>Test Terminal/span>span classp>;/span> span classnx>request/span>span classp>./span>span classnx>amount/span> span classo>/span> span classs1>55.00/span>span classp>;/span> span classnx>request/span>span classp>./span>span classnx>cardType/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>CardType/span>span classp>./span>span classnx>EBT/span> span classnx>client/span>span classp>./span>span classnx>charge/span>span classp>(/span>span classnx>request/span>span classp>)/span> span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>AuthorizationResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>})/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>@test/span>span classp>/span> span classo>/span> span classnb>@YES/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>@terminalName/span>span classp>/span> span classo>/span> span classs>@Test Terminal/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>@amount/span>span classp>/span> span classo>/span> span classs>@55.00/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>@cardType/span>span classp>/span> span classo>/span> span classn>CARD_TYPE_EBT/span>span classp>;/span> span classp>/span>span classn>client/span> span classnf>chargeWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@approved/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@approved/span>span classp>);/span> span classp>}/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@authCode/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@authCode/span>span classp>)/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@authorizedAmount/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@authorizedAmount/span>span classp>)/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classkc>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>request/span>span classp>/span>span classs>amount/span>span classp>/span> span classo>/span> span classs>55.00/span> span classn>request/span>span classp>/span>span classs>cardType/span>span classp>/span> span classo>/span> span classkt>CARD_TYPE_EBT/span> span classn>client/span>span classo>./span>span classnf>charge/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>approved/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>approved/span>span classp>)/span> span classp>}/span> span classkt>NSLog/span>span classp>(/span>span classs>authCode/span> span classo>+/span> span classs>: /span> span classo>+/span> span classp>(/span>span classn>response/span>span classp>/span>span classs>authCode/span>span classp>/span> span classk>as?/span> span classkt>String/span>span classp>)/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classkt>NSLog/span>span classp>(/span>span classs>authorizedAmount/span> span classo>+/span> span classs>: /span> span classo>+/span> span classp>(/span>span classn>response/span>span classp>/span>span classs>authorizedAmount/span>span classp>/span> span classk>as?/span> span classkt>String/span>span classp>)/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classp>::/span>span classnn>blockchyp/span>span classp>::/span>span classo>*/span>span classp>;/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classp>{/span> span classk>let/span> span classn>creds/span> span classo>/span> span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classk>mut/span> span classn>request/span> span classo>/span> span classn>AuthorizationRequest/span>span classp>{/span> span classn>test/span>span classp>:/span> span classk>true/span>span classp>,/span> span classn>terminal_name/span>span classp>:/span> span classs>Test Terminal/span>span classnf>.to_string/span>span classp>(),/span> span classn>amount/span>span classp>:/span> span classs>55.00/span>span classnf>.to_string/span>span classp>(),/span> span classn>card_type/span>span classp>:/span> span classnn>CardType/span>span classp>::/span>span classn>EBT/span>span classp>,/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.charge/span>span classp>(/span>span classo>&/span>span classk>mut/span> span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.approved/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>approved/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>approved/span>span classp>,/span>span classw> /span>span classs2>approved/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>authCode/span>span classp>:/span>span classw> /span>span classs2>353248/span>span classp>,/span>span classw> /span>span classs2>transactionId/span>span classp>:/span>span classw> /span>span classs2>CMKSS74OHAI6VG24AJBKYEIAAM/span>span classp>,/span>span classw> /span>span classs2>transactionRef/span>span classp>:/span>span classw> /span>span classs2>30828430488/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>charge/span>span classp>,/span>span classw> /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classs2>2020-05-04T22:25:08Z/span>span classp>,/span>span classw> /span>span classs2>tickBlock/span>span classp>:/span>span classw> /span>span classs2>000f694d8d7b497ae3730e92bb84af0c441ed66cd7200176aaf6c699052f8bf5/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>partialAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>altCurrency/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>fsaAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>currencyCode/span>span classp>:/span>span classw> /span>span classs2>USD/span>span classp>,/span>span classw> /span>span classs2>requestedAmount/span>span classp>:/span>span classw> /span>span classs2>55.00/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>55.00/span>span classp>,/span>span classw> /span>span classs2>remainingBalance/span>span classp>:/span>span classw> /span>span classs2>45.00/span>span classp>,/span>span classw> /span>span classs2>tipAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>taxAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>requestedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>authorizedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>SWIPE/span>span classp>,/span>span classw> /span>span classs2>paymentType/span>span classp>:/span>span classw> /span>span classs2>EBT/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************1112/span>span classp>,/span>span classw> /span>span classs2>cardHolder/span>span classp>:/span>span classw> /span>span classs2>BEGHETTI/NELSON/span>span classp>,/span>span classw> /span>span classs2>avsResponse/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>receiptSuggestions/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>merchantName/span>span classp>:/span>span classw> /span>span classs2>CLI Regression Test/span>span classp>,/span>span classw> /span>span classs2>requestSignature/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************1112/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>55.00/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>charge/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>SWIPE/span>span classp>,/span>span classw> /span>span classs2>pinVerified/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>cashBackAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>surcharge/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>cashDiscount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>customer/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>whiteListedCard/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>storeAndForward/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>p>EBT (Electronic Benefits Transfer) cards are payment cards used in the United States to accessgovernment food assistance programs. They replaced food stamps some years ago andhelp prevent people who are struggling financially from going hungry./p>p>Unfortunately EBT is an often overlooked part of a payments system since mostof us who build payment systems for a living are fortunate enough to not need them./p>p>At BlockChyp we believe payment methods intended to help people who arestruggling deserve extra effort and scrutiny. If you've ever been at the grocerystore behind a mother when the WIC or EBT redemption processes were slow or glitchy,you've seen the human cost of a poorly implemented EBT system./p>p>EBT systems should be simple and fast so as not to attract attention and spareEBT cardholders any unnecessary embarrassment or anxiety./p>p>Luckily supporting EBT in BlockChyp is easy. To run an EBT transaction, just setthe code>ebt/code> flag when you run a normal charge transaction./p>p>This will put the terminal in EBT mode, prompt the user for their EBT pin and executethe transaction. As a courtesy, we'll even return the remaining balance on the cardas part of the transaction response./p>p>strong>Manual EBT/strong>/p>p>EBT cards get beat up and their magnetic stripes wear out just like conventional magstripe cards. For this reason, we support a keyed entry mode for EBT cards.Just set the code>manual/code> flag along with code>ebt/code> to run a manual EBT transaction./p>p>strong>Balance Checks/strong>/p>p>The Balance API referenced above can be used to check the remaining balance onan EBT card without running a transaction. Just set the code>ebt/code> flag or CardType.You can likewise check the balance of a manually entered EBT card by addingthe code>manual/code> flag./p>aside classsuccess>b>EBT Testing/b>p>For test merchant accounts, BlockChyp assumes all test EBT cards have a startingbalance of $100.00./p>/aside>aside classwarning>Merchants must provide a letter from the USDA with their FNS number duringunderwriting in order to process EBT payments./aside>h1 idcryptocurrency>Cryptocurrency/h1>blockquote>p>Charge Example:/p>/blockquote>pre classhighlight shell tab-shell>code>Linux/Mac OS: ./blockchyp -test -cmdspan classo>/span>span classs2>charge/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -amountspan classo>/span>span classs2>25.00/span> -cryptospan classo>/span>span classs2>ANY/span>Windows: ./blockchyp.exe -test -cmdspan classo>/span>span classs2>charge/span> -terminalspan classo>/span>span classs2>Test Terminal/span> -amountspan classo>/span>span classs2>25.00/span> -cryptospan classo>/span>span classs2>ANY/span>/code>/pre>pre classhighlight go tab-go>code>span classk>package/span>span classx> /span>span classn>main/span>span classx>/span>span classk>import/span>span classx> /span>span classp>(/span>span classx> /span>span classs>fmt/span>span classx> /span>span classs>log/span>span classx> /span>span classn>blockchyp/span>span classx> /span>span classs>github.com/blockchyp/blockchyp-go/span>span classx>/span>span classp>)/span>span classx>/span>span classk>func/span>span classx> /span>span classn>chargeExample/span>span classp>()/span>span classx> /span>span classp>{/span>span classx> /span>span classc>// sample credentials/span>span classx> /span>span classn>creds/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>APICredentials/span>span classp>{/span>span classx> /span>span classn>APIKey/span>span classo>:/span>span classx> /span>span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span>span classx> /span>span classn>BearerToken/span>span classo>:/span>span classx> /span>span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span>span classx> /span>span classn>SigningKey/span>span classo>:/span>span classx> /span>span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classc>// instantiate the client/span>span classx> /span>span classn>client/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>NewClient/span>span classp>(/span>span classn>creds/span>span classp>)/span>span classx> /span>span classc>// setup request object/span>span classx> /span>span classn>request/span>span classx> /span>span classo>:/span>span classx> /span>span classn>blockchyp/span>span classo>./span>span classn>AuthorizationRequest/span>span classp>{/span>span classx> /span>span classn>Test/span>span classo>:/span>span classx> /span>span classno>true/span>span classp>,/span>span classx> /span>span classn>TerminalName/span>span classo>:/span>span classx> /span>span classs>Test Terminal/span>span classp>,/span>span classx> /span>span classn>Amount/span>span classo>:/span>span classx> /span>span classs>55.00/span>span classp>,/span>span classx> /span>span classn>Cryptocurrency/span>span classo>:/span>span classx> /span>span classs>ANY/span>span classp>,/span>span classx> /span>span classp>}/span>span classx> /span>span classn>response/span>span classp>,/span>span classx> /span>span classn>err/span>span classx> /span>span classo>:/span>span classx> /span>span classn>client/span>span classo>./span>span classn>Charge/span>span classp>(/span>span classn>request/span>span classp>)/span>span classx> /span>span classk>if/span>span classx> /span>span classn>err/span>span classx> /span>span classo>!/span>span classx> /span>span classno>nil/span>span classx> /span>span classp>{/span>span classx> /span>span classn>log/span>span classo>./span>span classn>Fatal/span>span classp>(/span>span classn>err/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classc>//process the result/span>span classx> /span>span classk>if/span>span classx> /span>span classn>response/span>span classo>./span>span classn>Approved/span>span classx> /span>span classp>{/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Println/span>span classp>(/span>span classs>approved/span>span classp>)/span>span classx> /span>span classp>}/span>span classx> /span>span classn>fmt/span>span classo>./span>span classn>Printf/span>span classp>(/span>span classs>Response: %+v/span>span classse>\n/span>span classs>/span>span classp>,/span>span classx> /span>span classn>response/span>span classp>)/span>span classx>/span>span classp>}/span>span classx>/span>/code>/pre>pre classhighlight csharp tab-csharp>code>span classc1>// Populate request parameters./span>span classn>AuthorizationRequest/span> span classn>request/span> span classp>/span> span classk>new/span> span classn>AuthorizationRequest/span>span classp>{/span> span classn>Test/span> span classp>/span> span classk>true/span>span classp>,/span> span classn>TerminalName/span> span classp>/span> span classs>Test Terminal/span>span classp>,/span> span classn>Amount/span> span classp>/span> span classs>55.00/span>span classp>,/span> span classn>Cryptocurrency/span> span classp>/span> span classs>ANY/span>span classp>,/span>span classp>};/span>span classc1>// Run the transaction./span>span classn>AuthorizationResponse/span> span classn>response/span> span classp>/span> span classk>await/span> span classn>blockchyp/span>span classp>./span>span classnf>ChargeAsync/span>span classp>(/span>span classn>request/span>span classp>);/span>span classc1>// View the result./span>span classn>Console/span>span classp>./span>span classnf>WriteLine/span>span classp>(/span>span classn>response/span>span classp>);/span>/code>/pre>pre classhighlight java tab-java>code>span classkn>package/span> span classn>com/span>span classo>./span>span classna>blockchyp/span>span classo>./span>span classna>client/span>span classo>./span>span classna>examples/span>span classo>;/span>span classkn>import/span> span classnn>java.util.ArrayList/span>span classo>;/span>span classkn>import/span> span classnn>java.util.Collection/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectMapper/span>span classo>;/span>span classkn>import/span> span classnn>com.fasterxml.jackson.databind.ObjectWriter/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.APICredentials/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.BlockChypClient/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.AuthorizationRequest/span>span classo>;/span>span classkn>import/span> span classnn>com.blockchyp.client.dto.AuthorizationResponse/span>span classo>;/span>span classkd>public/span> span classkd>class/span> span classnc>ChargeExample/span> span classo>{/span> span classnd>@SuppressWarnings/span>span classo>({/span> span classs>rawtypes/span>span classo>,/span> span classs>unchecked/span> span classo>})/span> span classkd>public/span> span classkd>static/span> span classkt>void/span> span classnf>main/span>span classo>(/span>span classn>String/span>span classo>/span> span classn>args/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>APICredentials/span> span classn>creds/span> span classo>/span> span classk>new/span> span classn>APICredentials/span>span classo>();/span> span classn>creds/span>span classo>./span>span classna>setApiKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_API_KEY/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setBearerToken/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_BEARER_TOKEN/span>span classo>));/span> span classn>creds/span>span classo>./span>span classna>setSigningKey/span>span classo>(/span>span classn>System/span>span classo>./span>span classna>getenv/span>span classo>(/span>span classs>BC_SIGNING_KEY/span>span classo>));/span> span classn>BlockChypClient/span> span classn>client/span> span classo>/span> span classk>new/span> span classn>BlockChypClient/span>span classo>(/span>span classn>creds/span>span classo>);/span> span classc1>// Set request parameters/span> span classn>AuthorizationRequest/span> span classn>request/span> span classo>/span> span classk>new/span> span classn>AuthorizationRequest/span>span classo>();/span> span classn>request/span>span classo>./span>span classna>setTest/span>span classo>(/span>span classkc>true/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setTerminalName/span>span classo>(/span>span classs>Test Terminal/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setAmount/span>span classo>(/span>span classs>55.00/span>span classo>);/span> span classn>request/span>span classo>./span>span classna>setCryptocurrency/span>span classo>(/span>span classs>ANY/span>span classo>);/span> span classc1>// Send the request/span> span classn>AuthorizationResponse/span> span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classna>charge/span>span classo>(/span>span classn>request/span>span classo>);/span> span classc1>// View the result/span> span classn>System/span>span classo>./span>span classna>out/span>span classo>./span>span classna>println/span>span classo>(/span>span classs>Response: /span> span classo>+/span> span classn>prettyPrint/span>span classo>(/span>span classn>response/span>span classo>));/span> span classo>}/span> span classkd>public/span> span classkd>static/span> span classn>String/span> span classnf>prettyPrint/span>span classo>(/span>span classn>Object/span> span classn>object/span>span classo>)/span> span classkd>throws/span> span classn>Exception/span> span classo>{/span> span classn>ObjectWriter/span> span classn>writer/span> span classo>/span> span classk>new/span> span classn>ObjectMapper/span>span classo>()/span> span classo>./span>span classna>writer/span>span classo>()/span> span classo>./span>span classna>withDefaultPrettyPrinter/span>span classo>();/span> span classk>return/span> span classn>object/span>span classo>./span>span classna>getClass/span>span classo>()./span>span classna>getSimpleName/span>span classo>()/span> span classo>+/span> span classs>: /span> span classo>+/span> span classn>writer/span>span classo>./span>span classna>writeValueAsString/span>span classo>(/span>span classn>object/span>span classo>);/span> span classo>}/span>span classo>}/span>/code>/pre>pre classhighlight php tab-php>code>span classcp><?php/span>span classc1>// For composer based systems/span>span classk>require_once/span>span classp>(/span>span classs1>vendor/autoload.php/span>span classp>);/span>span classc1>// For manual installation#require_once(/path/to/blockchyp/init.php);/span>span classk>use/span> span classnx>BlockChyp\BlockChyp/span>span classp>;/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setApiKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_API_KEY/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setBearerToken/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_BEARER_TOKEN/span>span classp>));/span>span classnx>BlockChyp/span>span classo>::/span>span classna>setSigningKey/span>span classp>(/span>span classnb>getenv/span>span classp>(/span>span classs1>BC_SIGNING_KEY/span>span classp>));/span>span classc1>// Populate request values/span>span classnv>$request/span> span classo>/span> span classp>/span> span classs1>test/span> span classo>>/span> span classkc>true/span>span classp>,/span> span classs1>terminalName/span> span classo>>/span> span classs1>Test Terminal/span>span classp>,/span> span classs1>amount/span> span classo>>/span> span classs1>55.00/span>span classp>,/span> span classs1>cryptocurrency/span> span classo>>/span> span classs1>ANY/span>span classp>,/span>span classp>;/span>span classnv>$response/span> span classo>/span> span classnx>BlockChyp/span>span classo>::/span>span classna>charge/span>span classp>(/span>span classnv>$request/span>span classp>);/span>span classc1>// View the result/span>span classk>echo/span> span classs1>Response: /span> span classo>./span> span classnb>print_r/span>span classp>(/span>span classnv>$response/span>span classp>,/span> span classkc>true/span>span classp>)/span> span classo>./span> span classnx>PHP_EOL/span>span classp>;/span>/code>/pre>pre classhighlight ruby tab-ruby>code>span classc1># frozen_string_literal: true/span>span classnb>require/span> span classs1>blockchyp/span>span classn>blockchyp/span> span classo>/span> span classno>BlockChyp/span>span classo>::/span>span classno>BlockChyp/span>span classp>./span>span classnf>new/span>span classp>(/span> span classno>ENV/span>span classp>/span>span classs1>BC_API_KEY/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_BEARER_TOKEN/span>span classp>,/span> span classno>ENV/span>span classp>/span>span classs1>BC_SIGNING_KEY/span>span classp>/span>span classp>)/span>span classc1># Set request parameters/span>span classn>request/span> span classo>/span> span classp>{/span> span classss>test: /span>span classkp>true/span>span classp>,/span> span classss>terminalName: /span>span classs1>Test Terminal/span>span classp>,/span> span classss>amount: /span>span classs1>55.00/span> span classss>cryptocurrency: /span>span classs1>ANY/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>blockchyp/span>span classp>./span>span classnf>charge/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classs2>Response: /span>span classsi>#{/span>span classn>response/span>span classp>./span>span classnf>inspect/span>span classsi>}/span>span classs2>/span>/code>/pre>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>os/span>span classkn>import/span> span classnn>blockchyp/span>span classc># initialize a client./span>span classn>client/span> span classo>/span> span classn>blockchyp/span>span classo>./span>span classn>Client/span>span classp>(/span> span classn>api_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_API_KEY/span>span classp>,/span> span classn>bearer_token/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_BEARER_TOKEN/span>span classp>,/span> span classn>signing_key/span>span classo>/span>span classn>os/span>span classo>./span>span classn>environ/span>span classp>/span>span classs>BC_SIGNING_KEY/span>span classp>,/span>span classp>)/span>span classc># populate request parameters./span>span classn>request/span> span classo>/span> span classp>{/span> span classs>test/span>span classp>:/span> span classbp>True/span>span classp>,/span> span classs>terminalName/span>span classp>:/span> span classs>Test Terminal/span>span classp>,/span> span classs>amount/span>span classp>:/span> span classs>55.00/span>span classp>,/span> span classs>cryptocurrency/span>span classp>:/span> span classs>ANY/span>span classp>,/span>span classp>}/span>span classc># run the transaction./span>span classn>response/span> span classo>/span> span classn>client/span>span classo>./span>span classn>charge/span>span classp>(/span>span classn>request/span>span classp>)/span>span classk>print/span>span classp>(/span>span classs>Response: /span>span classsi>%/span>span classs>r/span> span classo>%/span> span classn>response/span>span classp>)/span>/code>/pre>pre classhighlight javascript tab-javascript>code>span classkd>let/span> span classnx>BlockChyp/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs1>@blockchyp/blockchyp-js/span>span classp>);/span>span classkd>let/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classp>});/span>span classnx>client/span>span classp>./span>span classnx>charge/span>span classp>({/span> span classna>test/span>span classp>:/span> span classkc>true/span>span classp>,/span> span classna>terminalName/span>span classp>:/span> span classs1>Test Terminal/span>span classp>,/span> span classna>amount/span>span classp>:/span> span classs1>55.00/span>span classp>,/span> span classna>cryptocurrency/span>span classp>:/span> span classs1>ANY/span>span classp>,/span>span classp>})/span>span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>response/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>./span>span classnx>data/span>span classp>))/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>)/span> span classp>});/span>/code>/pre>pre classhighlight typescript tab-typescript>code> span classk>import/span> span classo>*/span> span classk>as/span> span classnx>BlockChyp/span> span classk>from/span> span classs1>@blockchyp/blockchyp-ts/span>span classp>;/span> span classkd>const/span> span classnx>client/span> span classo>/span> span classnx>BlockChyp/span>span classp>./span>span classnx>newClient/span>span classp>({/span> span classna>apiKey/span>span classp>:/span> span classs1>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classp>,/span> span classna>bearerToken/span>span classp>:/span> span classs1>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classp>,/span> span classna>signingKey/span>span classp>:/span> span classs1>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span> span classp>});/span> span classkd>const/span> span classnx>request/span> span classo>/span> span classk>new/span> span classnx>BlockChyp/span>span classp>./span>span classnx>AuthorizationRequest/span>span classp>();/span> span classnx>request/span>span classp>./span>span classnx>test/span> span classo>/span> span classkc>true/span>span classp>;/span> span classnx>request/span>span classp>./span>span classnx>terminalName/span> span classo>/span> span classs1>Test Terminal/span>span classp>;/span> span classnx>request/span>span classp>./span>span classnx>amount/span> span classo>/span> span classs1>55.00/span>span classp>;/span> span classnx>request/span>span classp>./span>span classnx>cryptocurrency/span> span classo>/span> span classs1>ANY/span>span classp>;/span> span classnx>client/span>span classp>./span>span classnx>charge/span>span classp>(/span>span classnx>request/span>span classp>)/span> span classp>./span>span classnx>then/span>span classp>(/span>span classkd>function/span>span classp>(/span>span classnx>httpResponse/span>span classp>)/span> span classp>{/span> span classkd>const/span> span classnx>response/span>span classp>:/span> span classnx>BlockChyp/span>span classp>./span>span classnx>AuthorizationResponse/span> span classo>/span> span classnx>httpResponse/span>span classp>./span>span classnx>data/span>span classp>;/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classs1>Response: /span> span classo>+/span> span classnx>JSON/span>span classp>./span>span classnx>stringify/span>span classp>(/span>span classnx>response/span>span classp>));/span> span classp>})/span> span classp>./span>span classk>catch/span>span classp>(/span>span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>:/span> span classkr>any/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classp>})/span>/code>/pre>pre classhighlight objective_c tab-objective_c>code>span classcp>#import <Foundation/Foundation.h>#import <BlockChyp/BlockChyp.h>/span>span classkt>int/span> span classnf>main/span> span classp>(/span>span classkt>int/span> span classn>argc/span>span classp>,/span> span classk>const/span> span classkt>char/span> span classo>*/span> span classn>argv/span>span classp>)/span>span classp>{/span> span classn>NSAutoreleasePool/span> span classo>*/span>span classn>pool/span> span classo>/span> span classp>/span>span classn>NSAutoreleasePool/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>BlockChyp/span> span classo>*/span>span classn>client/span> span classo>/span> span classp>/span>span classn>BlockChyp/span> span classnf>alloc/span>span classp>/span> span classnf>initWithApiKey/span>span classp>:/span>span classs>@SPBXTSDAQVFFX5MGQMUMIRINVI/span> span classnf>bearerToken/span>span classp>:/span>span classs>@7BXBTBUPSL3BP7I6Z2CFU6H3WQ/span> span classnl>signingKey:/span>span classs>@bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e/span>span classp>;/span> span classn>NSMutableDictionary/span> span classo>*/span>span classn>request/span> span classo>/span> span classp>/span>span classn>NSMutableDictionary/span> span classnf>alloc/span>span classp>/span> span classnf>init/span>span classp>;/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classnb>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>@Test Terminal/span> span classn>request/span>span classp>/span>span classs>amount/span>span classp>/span> span classo>/span> span classs>@55.00/span> span classn>request/span>span classp>/span>span classs>cryptocurrency/span>span classp>/span> span classo>/span> span classs>@ANY/span> span classp>/span>span classn>client/span> span classnf>chargeWithRequest/span>span classp>:/span>span classn>request/span> span classnf>handler/span>span classp>:/span>span classo>^/span>span classp>(/span>span classn>NSDictionary/span> span classo>*/span>span classn>request/span>span classp>,/span> span classn>NSDictionary/span> span classo>*/span>span classn>response/span>span classp>,/span> span classn>NSError/span> span classo>*/span>span classn>error/span>span classp>)/span> span classp>{/span> span classn>NSNumber/span> span classo>*/span>span classn>success/span> span classo>/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@approved/span>span classp>;/span> span classk>if/span> span classp>(/span>span classn>success/span>span classp>./span>span classn>boolValue/span>span classp>)/span> span classp>{/span> span classn>NSLog/span>span classp>(/span>span classs>@approved/span>span classp>);/span> span classp>}/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@authCode/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@authCode/span>span classp>)/span> span classn>NSLog/span>span classp>(/span>span classs>@%@: %@/span>span classp>,/span> span classs>@authorizedAmount/span>span classp>,/span> span classp>/span>span classn>response/span> span classnf>objectForKey/span>span classp>:/span>span classs>@authorizedAmount/span>span classp>)/span> span classp>};/span> span classp>/span>span classn>pool/span> span classnf>drain/span>span classp>;/span> span classk>return/span> span classmi>0/span>span classp>;/span>span classp>}/span>/code>/pre>pre classhighlight swift tab-swift>code>span classkd>import/span> span classkt>BlockChyp/span>span classkd>class/span> span classkt>ExampleClass/span> span classp>{/span> span classkd>func/span> span classnf>example/span>span classp>()/span> span classp>{/span> span classk>let/span> span classnv>client/span> span classo>/span> span classkt>BlockChyp/span>span classo>./span>span classnf>init/span>span classp>(/span> span classnv>apiKey/span>span classp>:/span> span classs>ZN5WQGX5PN6BE2MF75CEAWRETM/span>span classp>,/span> span classnv>bearerToken/span>span classp>:/span> span classs>SVVHJCYVFWJR2QKYKFWMZQVZL4/span>span classp>,/span> span classnv>signingKey/span>span classp>:/span> span classs>7c1b9e4d1308e7bbe76a1920ddd9449ce50af2629f6bb70ed3c110365935970b/span> span classp>)/span> span classk>var/span> span classnv>request/span>span classp>:/span> span classp>/span>span classkt>String/span>span classp>:/span>span classkt>Any/span>span classp>/span> span classo>/span> span classp>:/span> span classn>request/span>span classp>/span>span classs>test/span>span classp>/span> span classo>/span> span classkc>true/span> span classn>request/span>span classp>/span>span classs>terminalName/span>span classp>/span> span classo>/span> span classs>Test Terminal/span> span classn>request/span>span classp>/span>span classs>amount/span>span classp>/span> span classo>/span> span classs>55.00/span> span classn>request/span>span classp>/span>span classs>cryptocurrency/span>span classp>/span> span classo>/span> span classs>ANY/span> span classn>client/span>span classo>./span>span classnf>charge/span>span classp>(/span>span classnv>withRequest/span>span classp>:/span> span classn>request/span>span classp>,/span> span classnv>handler/span>span classp>:/span> span classp>{/span> span classp>(/span>span classn>request/span>span classp>,/span> span classn>response/span>span classp>,/span> span classn>error/span>span classp>)/span> span classk>in/span> span classk>let/span> span classnv>approved/span> span classo>/span> span classn>response/span>span classp>/span>span classs>approved/span>span classp>/span> span classk>as?/span> span classkt>Bool/span> span classk>if/span> span classp>(/span>span classn>approved/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>{/span> span classkt>NSLog/span>span classp>(/span>span classs>approved/span>span classp>)/span> span classp>}/span> span classkt>NSLog/span>span classp>(/span>span classs>authorizedAmount/span> span classo>+/span> span classs>: /span> span classo>+/span> span classp>(/span>span classn>response/span>span classp>/span>span classs>authorizedAmount/span>span classp>/span> span classk>as?/span> span classkt>String/span>span classp>)/span>span classo>./span>span classn>unsafelyUnwrapped/span>span classp>)/span> span classp>})/span> span classp>}/span>/code>/pre>pre classhighlight rust tab-rust>code>span classk>use/span> span classp>::/span>span classnn>blockchyp/span>span classp>::/span>span classo>*/span>span classp>;/span>span classk>fn/span> span classnf>main/span>span classp>()/span> span classp>{/span> span classk>let/span> span classn>creds/span> span classo>/span> span classn>APICredentials/span> span classp>{/span> span classn>api_key/span>span classp>:/span> span classs>ZDSMMZLGRPBPRTJUBTAFBYZ33Q/span>span classnf>.to_string/span>span classp>(),/span> span classn>bearer_token/span>span classp>:/span> span classs>ZLBW5NR4U5PKD5PNP3ZP3OZS5U/span>span classnf>.to_string/span>span classp>(),/span> span classn>signing_key/span>span classp>:/span> span classs>9c6a5e8e763df1c9256e3d72bd7f53dfbd07312938131c75b3bfd254da787947/span>span classnf>.to_string/span>span classp>(),/span> span classp>};/span> span classk>let/span> span classn>client/span> span classo>/span> span classnn>Client/span>span classp>::/span>span classnf>new/span>span classp>(/span>span classn>creds/span>span classp>);/span> span classk>let/span> span classk>mut/span> span classn>request/span> span classo>/span> span classn>AuthorizationRequest/span>span classp>{/span> span classn>test/span>span classp>:/span> span classk>true/span>span classp>,/span> span classn>terminal_name/span>span classp>:/span> span classs>Test Terminal/span>span classnf>.to_string/span>span classp>(),/span> span classn>amount/span>span classp>:/span> span classs>55.00/span>span classnf>.to_string/span>span classp>(),/span> span classn>cryptocurrency/span>span classp>:/span> span classnf>Some/span>span classp>(/span>span classs>ANY/span>span classnf>.to_string/span>span classp>()),/span> span classerr>./span>span classpy>.Default/span>span classp>::/span>span classnf>default/span>span classp>()/span> span classp>};/span> span classk>let/span> span classp>(/span>span classn>response/span>span classp>,/span> span classn>err/span>span classp>)/span> span classo>/span> span classn>client/span>span classnf>.charge/span>span classp>(/span>span classo>&/span>span classk>mut/span> span classn>request/span>span classp>);/span> span classk>if/span> span classk>let/span> span classnf>Some/span>span classp>(/span>span classn>e/span>span classp>)/span> span classo>/span> span classn>err/span> span classp>{/span> span classnd>eprintln!/span>span classp>(/span>span classs>Unexpected error occurred: {:?}/span>span classp>,/span> span classn>e/span>span classp>);/span> span classk>return/span> span classp>}/span> span classk>if/span> span classn>response/span>span classpy>.approved/span> span classp>{/span> span classnd>println!/span>span classp>(/span>span classs>approved/span>span classp>);/span> span classp>}/span> span classnd>println!/span>span classp>(/span>span classs>Response: {:?}/span>span classp>,/span> span classn>response/span>span classp>);/span>span classp>}/span>/code>/pre>blockquote>p>Example response encoded as JSON:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>pending-confirmation/span>span classp>,/span>span classw> /span>span classs2>approved/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>transactionId/span>span classp>:/span>span classw> /span>span classs2>STBGKO7HOQI6ZPBHAJBKYEIAAQ/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>EP55BSHHNEI6ZLCSAJBKYEIAAQ/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>charge/span>span classp>,/span>span classw> /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classs2>2022-06-08T21:47:22Z/span>span classp>,/span>span classw> /span>span classs2>tickBlock/span>span classp>:/span>span classw> /span>span classs2>000c235065f7e89c264efffca8d05c7d4f85c3c78362faf9855c010c72eb46d2/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>partialAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>altCurrency/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>fsaAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>currencyCode/span>span classp>:/span>span classw> /span>span classs2>USD/span>span classp>,/span>span classw> /span>span classs2>requestedAmount/span>span classp>:/span>span classw> /span>span classs2>4.20/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>remainingBalance/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>tipAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>taxAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>requestedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>authorizedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>confirmed/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>cryptoAuthorizedAmount/span>span classp>:/span>span classw> /span>span classs2>0.00013862/span>span classp>,/span>span classw> /span>span classs2>cryptoNetworkFee/span>span classp>:/span>span classw> /span>span classs2>0.000001410/span>span classp>,/span>span classw> /span>span classs2>cryptocurrency/span>span classp>:/span>span classw> /span>span classs2>BTC/span>span classp>,/span>span classw> /span>span classs2>cryptoNetwork/span>span classp>:/span>span classw> /span>span classs2>L1/span>span classp>,/span>span classw> /span>span classs2>cryptoReceiveAddress/span>span classp>:/span>span classw> /span>span classs2>tb1qvsktxrcefpy5cvvvhsn2rs8f6hnynmgnp98v9h/span>span classp>,/span>span classw> /span>span classs2>cryptoBlock/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>cryptoTransactionId/span>span classp>:/span>span classw> /span>span classs2>e39385e8a1bbd4e855a7ab11ab09995fcbcb445df77be55af91807b989612f8e/span>span classp>,/span>span classw> /span>span classs2>cryptoPaymentRequest/span>span classp>:/span>span classw> /span>span classs2>bitcoin:tb1qvsktxrcefpy5cvvvhsn2rs8f6hnynmgnp98v9h?amount0.00013862&labelCLI+Regression+Test/span>span classp>,/span>span classw> /span>span classs2>cryptoStatus/span>span classp>:/span>span classw> /span>span classs2>pending-confirmation/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>CRYPTO/span>span classp>,/span>span classw> /span>span classs2>paymentType/span>span classp>:/span>span classw> /span>span classs2>BTC/span>span classp>,/span>span classw> /span>span classs2>avsResponse/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>receiptSuggestions/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>terminalId/span>span classp>:/span>span classw> /span>span classs2>N27CXMG5KYI6ZH5DAJBKYEIAAM/span>span classp>,/span>span classw> /span>span classs2>merchantName/span>span classp>:/span>span classw> /span>span classs2>CLI Regression Test/span>span classp>,/span>span classw> /span>span classs2>merchantId/span>span classp>:/span>span classw> /span>span classs2>MFLQFJUJJAI6TBE3AJBKYEIAAQ/span>span classp>,/span>span classw> /span>span classs2>requestSignature/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>charge/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>CRYPTO/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>customer/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>customers/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>whiteListedCard/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>storeAndForward/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>p>BlockChyp has recently unveiled basic support for cryptocurrency transactions includingBitcoin. The development effort required to support crypto is minimal, but somedevelopment effort is needed in order to avoid confusing end of day procedures./p>p>For example, if crypto were treated as just another payment method, it could lead to discrepancies between actual merchant deposits and expected deposits./p>p>Running a crypto transaction is identical to a normal charge transaction, with one exception. Cryptocurrencytransactions are enabled via the code>crypto/code> parameter. Developers can pass in a three digitcurrency code to specify a specific cryptocurrency, or code>ANY/code> in order to support any cryptocurrencythe merchant may have enabled. Use of the code>ANY/code> value will ensure that your point-of-sale systemdoesn't need updating as BlockChyp rolls out support for additional cryptocurrencies or second levelnetworks over time./p>p>When a crypto transaction is initiated, the terminal will convert the amount requested into the selectedcryptocurrency at the current exchange rate (updated every ten minutes) and display a QR code on the terminal.The customer is then prompted to use their mobile crypto wallet to submit a transaction directlyto the network. BlockChyp will scan the blockchain and provide a response to the terminal once thetransaction is detected on the public crypto network./p>p>Since crypto transactions aren't always confirmed right away, the code>approved/code> flag is normally returned as false until a transaction is confirmed. Developers should look at the cryptocurrency fields in the response to determine which cryptocurrency was used, the exchange rate, fee paid by the sender and other relevant fields./p>p>Developers should consider a transaction paid when the code>cryptoStatus/code> field is code>pending-confirmation/code> or code>confirmed/code>./p>h2 idcrypto-response-fields>Crypto Response Fields/h2>p>The fields below are unique to crypto transactions and may be needed to properly support crypto transactions in point-of-sale systems./p>ul>li>strong>cryptocurrency:/strong> The common currency code identifying the cryptocurrency used for the transactions. (e.g. BTC for Bitcoin)/li>li>strong>cryptoNetwork:/strong> Specifies if the transactions was processed on the main blockchain or a second level network. For example, code>L1/code> indicates the Bitcoin main chain and code>L2/code> would indicate Bitcoin Lighting./li>li>strong>cryptoAuthorizedAmount:/strong> Authorized amount in cryptocurrency./li>li>strong>cryptoNetworkFee:/strong> Fee paid to the crypto network or miner by the sender./li>li>strong>cryptoReceiveAddress:/strong> Address the transaction was sent to. Should an address controlled by the merchant./li>li>strong>cryptoBlock:/strong> Hash or ID of the block a transaction is placed in. May be empty for L2 networks or until a transaction is mined./li>li>strong>cryptoTransactionId:/strong> Identifier assigned to the transaction by the crypto/blockchain network./li>li>strong>cryptoPaymentRequest:/strong> Full payment request URI that was encoded as QR code on the terminal when payment was requested./li>li>strong>cryptoStatus:/strong> Status of the crypto transactions. Usually code>pending-confirmation/code> or code>confirmed/code>./li>/ul>h2 idcrypto-batches>Crypto Batches/h2>p>To avoid confusing FIAT (US Dollar) transactions with cryptocurrency transactions, crypto transactionsare grouped into special batches called crypto batches. This means that a merchant that does a mixture of conventional payments and crypto payments will have two batches per day./p>h2 idbitcoin>Bitcoin/h2>p>As of this writing, BlockChyp only supports Level 1 Bitcoin transactions, but Lightning support andother cryptocurrency support is planned. In order to receive Bitcoin,Merchants must first enable Bitcoin in the Cryptocurrency settings section of the merchant portal and configure a default receive address. Merchants may optionally enable Custom Bitcoin Addresses if the point of sale solution has access to the hot Bitcoin wallet and the capability to generateunique receive addresses for each transaction. Otherwise, leave Custom Bitcoin Addresses disabled./p>p>By default, Merchants are responsible for creating their own wallets or opening their own exchange accounts to receive and manage their Bitcoin./p>h3 idconfirmation-time-and-risk>Confirmation Time and Risk/h3>p>Bitcoin transactions on the main blockchain are not instantaneous and care should be taken to preventfraud. In order for a Bitcoin transaction to be considered irreversible, it's customary to wait for six confirmations. This means that a transaction is picked up by a miner, placed into a block, and fiveadditional blocks are produced/mined by the network. This can take several hours. We recommend developers verify that crypto transactions are confirmed as part of closing or end of day procedures via theTransaction Status API./p>p>We also recommend that merchants take steps to either prevent the release of merchandise or services until crypto transactions are fully confirmed or set an upper limit on the value of merchandise thatcan be released without confirmation. BlockChyp will provide warnings when an unconfirmed Bitcointransaction is likely to be fraudulent due to paying below market transaction fees./p>h3 idbitcoin-refunds>Bitcoin Refunds/h3>p>Bitcoin refunds require access to the merchant's wallet and are not supported at this time. In order to processa refund, the merchant must use their wallet or crypto exchange and process the refund manually./p>h3 idtesting-bitcoin-transactions>Testing Bitcoin Transactions/h3>p>All test merchant accounts assume use of Bitcoin's testnet3 network and blockchain. In order to testBitcoin transactions, we recommend you download a mobile wallet with testnet support (like Bitpay)and configure a testnet3 wallet. There are a number of public testnet3 faucets that can be used to obtain testnet3 Bitcoin for testing./p>h1 idcash-discounting>Cash Discounting/h1>p>Cash discounting is another payments industry nonsense term. The payments industryfrequently uses the word discount when they mean fees, and this is no exception.Cash discounting is the practice of adding surcharges to cover credit cardprocessing fees and removing those fees (or discounting them) when the customer paysin cash or with a debit card./p>p>BlockChyp begrudgingly supports cash discounting in several different ways./p>p>strong>Surcharging/strong>/p>p>This method treats cash and debit transactions normally and only adds a surchargewhen an eligible credit card is presented./p>p>Use the code>surcharge/code> flag by itself to enable this method./p>p>strong>Surcharging With Cash Discounting/strong>/p>p>This method adds a surcharge to all transactions, but adds an offsetting cashdiscount when a Debit, EBT, or Gift Card is presented./p>aside classsuccess>b>Most Common/b>p>This is the most common cash discount variant. Use the code>surcharge/code>and code>cashDiscount/code> flags in every cash discount eligible transactionrequest./p>/aside>p>Use the code>surcharge/code> and the code>cashDiscount/code> flags to enable this method./p>p>strong>True Cash Discounting/strong>/p>p>This method never applies a surcharge, but may apply an automatic discount ifthe customer pays with Debit, Gift Card or EBT. This is probably the mosthonest way to support cash discounting, but it requires that merchants raise theirprices in order to build the credit card fees in. It's usually not what's intended./p>p>Use the code>cashDiscount/code> flag by itself to support this method./p>aside classwarning>Be very careful when using the code>cashDiscount/code> flag by itself. This willreduce transaction totals./aside>p>strong>Merchant Setup/strong>/p>p>Only merchants on Flat Rate pricing are eligible for Cash Discounting since interchangerates are not known in real time. There are additional underwriting steps forcash discount merchants./p>p>strong>Testing Cash Discounting/strong>/p>p>To enable a test merchant account for cash discounting, login into the developerportal, bring up the test merchant you'd like to configure and click 'TEST SETTINGS'./p>p>Here you'll see an option for enabling cash discounting./p>p>strong>Fractional Pennies With Split Payments/strong>/p>p>Surcharging often involves rounding fractional pennies to arrive at a final surcharge total. By default, all fractional pennies are rounded up to the nearest penny. This is normally fine, but in a split tender situation rounding up all payments can end up overcharging the customer by an extra penny./p>p>To prevent this issue, developers can override the default rounding mode by passing in an alternate rounding mode parameter with an authorization request.Supported values for this parameter are code>up/code>, code>down/code>, and code>nearest/code>./p>p>Note that rounding mode impacts surcharge calculations only and won't impact any other aspect of the transaction./p>h1 idcloud-relay-mode>Cloud Relay Mode/h1>p>By default, BlockChyp communicates with terminals over the local network. Terminalsannounce their local IP address as part of the activation process and continuallyupdate it as DHCP leases expire. The SDKs also have some fault tolerance andfailure handling logic built in to keep terminals up and running even if internetaccess is down./p>p>This is great if your system is running on the same network as the terminal, butan increasing number of point-of-sale systems are cloud based. If your systemis one of these cloud based systems, local communication with the payment terminal isn't possible./p>p>This is why we have cloud relay mode. In cloud relay mode, the SDKs routeall terminal requests through our secure cloud and back down to the destinationterminals (without requiring any custom router or firewall configuration)./p>p>You don't code for cloud relay any differently than you code for locally networkedterminals. It's all handled under the SDK abstraction. This means that if yoursystem has cloud based and on prem deployment models, you can use the same code./p>p>strong>Enabling Cloud Relay/strong>/p>p>Cloud relay is turned on during terminal activation. Just check the extra boxduring activation to enable it./p>aside classsuccess>b>Forcing Cloud Relay/b>p>If your application only works with BlockChyp terminals in cloud relay mode, justlet us know. We can configure your partner account to always activate yourmerchants terminals in cloud relay mode./p>/aside>p>strong>The Down Side of Cloud Relay/strong>/p>ul>li>p>strong>More Overhead/strong>: There's a bit more overhead required to run cloud relay transactions sinceevery SDK request goes out to the cloud and back. It's still much fasterthan most payment systems, but it is a little slower than local mode./p>/li>li>p>strong>No Store and Forward Support/strong>: Because the Internet is required for cloudrelay mode, offline authorization via store and forward is not supported./p>/li>/ul>h1 idstore-and-forward>Store and Forward/h1>blockquote>p>Store and forward example response:/p>/blockquote>pre classhighlight json tab-json>code>span classp>{/span>span classw>/span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw>/span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw>/span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>Approved Offline (SF)/span>span classp>,/span>span classw>/span>span classs2>approved/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw>/span>span classs2>authCode/span>span classp>:/span>span classw> /span>span classs2>000000/span>span classp>,/span>span classw>/span>span classs2>transactionId/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw>/span>span classs2>transactionRef/span>span classp>:/span>span classw> /span>span classs2>54300670144/span>span classp>,/span>span classw>/span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>charge/span>span classp>,/span>span classw>/span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classs2>2020-05-04T23:39:05Z/span>span classp>,/span>span classw>/span>span classs2>tickBlock/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw>/span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw>/span>span classs2>partialAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw>/span>span classs2>altCurrency/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw>/span>span classs2>fsaAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw>/span>span classs2>currencyCode/span>span classp>:/span>span classw> /span>span classs2>USD/span>span classp>,/span>span classw>/span>span classs2>requestedAmount/span>span classp>:/span>span classw> /span>span classs2>7.77/span>span classp>,/span>span classw>/span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>7.77/span>span classp>,/span>span classw>/span>span classs2>remainingBalance/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw>/span>span classs2>tipAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw>/span>span classs2>taxAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw>/span>span classs2>requestedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw>/span>span classs2>authorizedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw>/span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>CHIP/span>span classp>,/span>span classw>/span>span classs2>paymentType/span>span classp>:/span>span classw> /span>span classs2>DISC/span>span classp>,/span>span classw>/span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************0133/span>span classp>,/span>span classw>/span>span classs2>cardHolder/span>span classp>:/span>span classw> /span>span classs2>UAT USA/Test Card 15/span>span classp>,/span>span classw>/span>span classs2>avsResponse/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw>/span>span classs2>receiptSuggestions/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>aid/span>span classp>:/span>span classw> /span>span classs2>A0000001523010/span>span classp>,/span>span classw> /span>span classs2>arqc/span>span classp>:/span>span classw> /span>span classs2>BA5ABFB8BC87C15A/span>span classp>,/span>span classw> /span>span classs2>iad/span>span classp>:/span>span classw> /span>span classs2>0106A00003400000/span>span classp>,/span>span classw> /span>span classs2>tvr/span>span classp>:/span>span classw> /span>span classs2>8000048800/span>span classp>,/span>span classw> /span>span classs2>tsi/span>span classp>:/span>span classw> /span>span classs2>6800/span>span classp>,/span>span classw> /span>span classs2>applicationLabel/span>span classp>:/span>span classw> /span>span classs2>DISCOVER/span>span classp>,/span>span classw> /span>span classs2>requestSignature/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************0133/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>7.77/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>charge/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>CHIP/span>span classp>,/span>span classw> /span>span classs2>pinVerified/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>cashBackAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>surcharge/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>cashDiscount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw>/span>span classp>},/span>span classw>/span>span classs2>customer/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>/span>span classs2>whiteListedCard/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw>/span>span classs2>storeAndForward/span>span classp>:/span>span classw> /span>span classkc>true/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>p>Sometimes the Internet goes down./p>p>BlockChyp's store and forward system allows merchants to keep processing transactionson a restricted basis even if the internet is down and we're unable to obtain online authorizations.Offline transactions are encrypted and stored in the terminal's flash memory untilInternet service is restored. Terminals can store up to 100 offline transactions./p>p>There's no special coding required to unlock this functionality although you may wantto keep track of store and forward transactions in your system so you can checkto make sure they went through later. S&F transactions arealways identified with the code>storeAndForward/code> flag./p>p>If you plan to support store and forward, you might consider keeping track of transactionsthat return this flag and use the Transaction Status API to get the online authorizationstatus of transactions once they finally make it to the gateway./p>p>strong>Enabling Store and Forward/strong>/p>p>Store and Forward must be specifically enabled in the merchant profile and merchantsmust choose a floor limit. The terminal will authorize transactions below the floorlimit offline and reject transactions above the floor limit./p>aside classwarning>b>Cloud Relay Mode/b>p>Unfortunately store and forward doesnt work in cloud relay mode because an Internet outagewould mean theres no network route between your application and the terminal./p>/aside>p>strong>The Risk/strong>/p>p>When using store and forward, the merchant is accepting the risk that some transactionsmay be declined online. There's usually no recourse in these situations, sostore and forward should be used carefully or not at all in industries with high decline rates.In some cases our underwriters may disable it outright./p>p>strong>Testing Store and Forward/strong>/p>p>Testing this sort of thing has been historically tricky. The processors just tellus it works and we hope they turn out to be right. Usually they're not./p>p>Of course, you could always just unplug your Internet every time you want totest Store and Forward. And you should try that at least once, just so you know itreally works, but it's not a good idea to knock the whole office offline every timeyou want to test it./p>p>For this reason, we have special trigger values that allow you to simulate Storeand Forward transactions. Because you'll want to test transactions above or belowthe floor limit, instead of a single trigger value, we support any amount with all sevens./p>p>For example, all of the following are valid store and forward simulation trigger amounts:/p>ul>li>0.07/li>li>0.77/li>li>7.77/li>li>77.77/li>/ul>p>You get the idea. When you run a transaction against a test merchant account withone of these trigger amounts, the terminal will simulate a network failure during authorization. You'llget the same response you'd get for a live Store and Forward transaction./p>p>The terminal will wait two minutes and then enter an exponential retry loopto obtain online authorization just like it would with a real network outage./p>p>If your network is healthy, you should see your transaction in the gateway batchhistory within 2-3 minutes./p>h1 idreceipt-requirements>Receipt Requirements/h1>pre classhighlight json tab-json>code>span classp>{/span>span classw> /span>span classs2>approved/span>span classp>:/span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classs2>Approved/span>span classp>,/span>span classw> /span>span classs2>transactionId/span>span classp>:/span>span classs2>NZ6FGYAYLYI6TLVWNSLM7WZLHE/span>span classp>,/span>span classw> /span>span classs2>transactionRef/span>span classp>:/span>span classs2>cfd068099a4280f1f09a965d9cc522f25ef4e06a95c9a9461d59fa5deed62180/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classs2>charge/span>span classp>,/span>span classs2>timestamp/span>span classp>:/span>span classs2>2019-01-15T00:42:36Z/span>span classp>,/span>span classw> /span>span classs2>tickBlock/span>span classp>:/span>span classs2>000e61f8204a2a372cac288f833a8e0949dd50d0074d5133432dce4e78d97913/span>span classp>,/span>span classw> /span>span classs2>authCode/span>span classp>:/span>span classs2>612797/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classs2>CHIP/span>span classp>,/span>span classw> /span>span classs2>paymentType/span>span classp>:/span>span classs2>VISA/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classs2>************0010/span>span classp>,/span>span classw> /span>span classs2>cardHolder/span>span classp>:/span>span classs2>Test/Card 01 /span>span classp>,/span>span classw> /span>span classs2>partialAuth/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>altCurrency/span>span classp>:/span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>currencyCode/span>span classp>:/span>span classs2>USD/span>span classp>,/span>span classw> /span>span classs2>requestedAmount/span>span classp>:/span>span classs2>20.55/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classs2>20.55/span>span classp>,/span>span classw> /span>span classs2>receiptSuggestions/span>span classp>:{/span>span classw> /span>span classs2>aid/span>span classp>:/span>span classs2>A0000000031010/span>span classp>,/span>span classw> /span>span classs2>arqc/span>span classp>:/span>span classs2>E0A09074268A87F4/span>span classp>,/span>span classw> /span>span classs2>iad/span>span classp>:/span>span classs2>06010A03A0B800/span>span classp>,/span>span classw> /span>span classs2>tvr/span>span classp>:/span>span classs2>0240008000/span>span classp>,/span>span classw> /span>span classs2>tsi/span>span classp>:/span>span classs2>E800/span>span classp>,/span>span classw> /span>span classs2>merchantName/span>span classp>:/span>span classs2>Test Merchant/span>span classp>,/span>span classw> /span>span classs2>applicationLabel/span>span classp>:/span>span classs2>VISA CREDIT/span>span classp>,/span>span classw> /span>span classs2>requestSignature/span>span classp>:/span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classs2>************0010/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classs2>20.55/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classs2>charge/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classs2>CHIP/span>span classw> /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>p>BlockChyp API responses include information that most developers will use to create printed receipts.Consider the sample transaction response./p>p>The response includes a number of fields consumers are used to seeing on receipts such as masked PAN and auth code./p>p>It also includes a code>receiptSuggestions/code> section that collects all EMV fields we recommend putting on your receipts./p>p>Not all card brands have the same requirements, but if you always include the following data elements on all receipts, your receipts will be compliant with all card brand receipt requirements and recommendations./p>ul>li>strong>authCode/strong>/li>li>strong>maskedPan/strong>/li>li>strong>aid/strong>/li>li>strong>applicationLabel/strong>/li>li>strong>arqc/strong>/li>/ul>h1 idweb-tokenizer>Web Tokenizer/h1>p>BlockChyp was created to make terminal based payments simpler and easier, butwe still do e-commerce, even for ourselves when merchants buy terminals./p>p>We support e-commerce in a variety of architectures, from direct useof the API (which would put e-commerce developers in PCI scope) to the moremodern approach of in-browser tokenization./p>p>The BlockChyp Tokenizer is a JavaScript library you can embed in web applicationsto capture and tokenize payment methods. It captures sensitive card data in across origin hosted iframe, keeping your system out of PCI Scope. You get back a tokenyou can then use to interact with the BlockChyp core APIs just like any other token./p>p>The code, documentation, and more information about the Web Tokenizer can befound on a hrefhttps://github.com/blockchyp/blockchyp-tokenizer>Github/a>./p>h1 idcustomers-and-tokens>Customers and Tokens/h1>p>In addition to basic tokenization, BlockChyp provides APIs for linkingtokens to customer records, managing tokens, and managing or searchingcustomer records./p>aside classinfo>The examples this section will focus mainly on the Command Line Interface (CLI),but all APIs described below are also available for all SDKs. Consultthe Transaction Reference above for SDK specific examples./aside>h2 idcreating-tokens>Creating Tokens/h2>p>Tokens can be created three different ways: via the web tokenizer, via the enroll transaction, or via sideband enrollment by adding the enroll flag to a charge, preauth, or refund transaction./p>p>Note that the examples that follow create a token only. Subsequentsections will get into how customer records can be created and linked to payment tokens./p>h3 idweb-tokenizer-2>Web Tokenizer/h3>p>For ecommerce transactions, nearly all transactions are tokenized via the BlockChyp Web Tokenizer. This technique leverages theweb tokenizing library to tokenize a payment method directly in the browser/p>p>Consult the section above for more detail about the web tokenizer./p>h3 iddirect-enrollment>Direct Enrollment/h3>p>The enroll API can be used to tokenize a card with a payment terminal.br>Here's a CLI based example:/p>p>code>./blockchyp -test -terminal"Test Terminal" -type"enroll"/code>/p>div classcenter-column>{ success: true, error: , responseDescription: approved, approved: true, authCode: 727291, transactionId: KJ3DPKELBAI6VOTWNSLM7WZLHE, transactionRef: 64614152008, transactionType: enroll, timestamp: 2020-04-30T20:49:26Z, tickBlock: 009991a8ac7b6a4420760e1e14e1689c88be2a610a033d6908c1b04b5c00f9da, test: true, token: EKROTO2K5BCQJT4I555LQJLMWA, entryMethod: CHIP, paymentType: VISA, maskedPan: ************0010, cardHolder: UAT USA/Test Card 04, avsResponse: , receiptSuggestions: { aid: A0000000031010, arqc: 3404F82DA10F3FF5, iad: 06010A03A0B800, tvr: 8000008800, tsi: 6800, merchantName: Test Merchant, applicationLabel: VISA CREDIT, requestSignature: false, maskedPan: ************0010, authorizedAmount: , transactionType: enroll, entryMethod: CHIP }, customer: null}/div>p>The token returned in the response can then be used for future transactions./p>h3 idsideband-enrollment>Sideband Enrollment/h3>p>A slight variation on using the enroll API is to run a terminal charge, preauth, or refund transaction with the code>enroll/code> flag set to true./p>p>Here's a simple CLI based example.../p>p>code>./blockchyp -test -terminal"Test Terminal" -type"charge" -enroll -amount"5.00/code>/p>div classcenter-column>{ success: true, error: , responseDescription: approved, approved: true, authCode: 288850, authResponseCode: approved, transactionId: BHR26LRF7EI6ZB2KVTPEQAAREI, batchId: XK4LRSBF6II6ZB7TVTPEQAAREI, transactionType: charge, timestamp: 2021-10-05T17:21:24Z, tickBlock: 0000d8b23edb084a946aa9d9186a2f08cc579634680d9849d6ac730234106e8f, test: true, partialAuth: false, altCurrency: false, fsaAuth: false, currencyCode: USD, requestedAmount: 5.00, authorizedAmount: 5.00, remainingBalance: , tipAmount: 0.00, taxAmount: 0.00, requestedCashBackAmount: 0.00, authorizedCashBackAmount: 0.00, token: CBXJIJV5RH6JKXLBOY5O3WAI2A, entryMethod: CHIP, paymentType: VISA, maskedPan: ************0010, cardHolder: UAT USA/Test Card 04, expMonth: 12, expYear: 22, avsResponse: , receiptSuggestions: { aid: A0000000031010, arqc: 3C7561777A9AAF2F, iad: 06010A03A0B800, tvr: 8000008800, tsi: 6800, merchantName: Test Merchant, applicationLabel: Visa Credit, requestSignature: false, maskedPan: ************0010, authorizedAmount: 5.00, transactionType: charge, entryMethod: CHIP, cvmUsed: No CVM, cashBackAmount: 0.00, surcharge: 0.00, cashDiscount: 0.00 }, customer: null, whiteListedCard: null, storeAndForward: false}/div>p>This will run the requested transaction and return a reusable token if the transaction is approved./p>h2 idcreating-customer-records>Creating Customer Records/h2>p>Customer records can be created directly through the customer API or aspart of a payment or enroll transaction./p>h3 iddirect-customer-creation>Direct Customer Creation/h3>p>The most straightforward way to create a customer record is to use thecustomer API directly. This method creates a plain customer record withno associated payment records./p>p>The following example shows how this can be done via the CLI. Examplesfor all programming languages can be found above in the Transaction Referencesection./p>p>code>./blockchyp -test -type"update-customer" -customerRef"MYID" -firstName"Peter" -lastName"Gregory" -companyName"Raviga Capital" -email"peter@raviga.capital" -sms"9136488888"/code>/p>div classcenter-column>{ success: true, error: , responseDescription: , customer: { id: P7UV23UOEII6VJCUAJBKYEIAAI, customerRef: MYID, firstName: Peter, lastName: Gregory, companyName: Raviga Capital, emailAddress: peter@raviga.capital, smsNumber: 9136488888, paymentMethods: null }}/div>p>Once this record has been created, the customer id returned in the responsecan be used to link subsequent payment transactions to the customer recordor to associate payment tokens with the customer./p>p>Once created, a customer record can be modified by calling this came API with a customer id or customer ref./p>aside classinfo>We recommend all customer records include a value for b>customer ref/b>. This value can be whatever you want, but is usually your applications unique identifier for a customer record./aside>h3 idsideband-customer-creation>Sideband Customer Creation/h3>p>Customer records can also be created inline as part of a transaction by passingoptional customer information./p>h3 idweb-tokenizer-3>Web Tokenizer/h3>p>A payment method enrolled in the token vault via the web tokenizercan also be linked to a customer record./p>p>All that's needed is to add a customer value to the request beforecalling the tokenize method as shown below:/p>div classcenter-column>var req { test: true, transactionRef: YOUR TRANSACTION OR TENDER ID, cardholderName: $(#cardholder).val(), customer: { customerRef: MYID, firstName: Peter, lastName: Gregory, companyName: Raviga Capital, emailAddress: peter@raviga.capital, smsNumber: 9136488888, }}tokenizer.tokenize(TOKENIZING_KEY>, req) .then(function (response) { ... }) .catch(function (error) { ... })}/div>h3 idterminal-transactions>Terminal Transactions/h3>p>Customers can also be created inline as part of a terminal transaction. TheAuthorizationRequest data model has an optional customer field that can be usedto pass in customer information. If customer data is provided, the customer will be created as a side effect of the transaction./p>p>There are also optional command line arguments that provide a shortcut for passingin customer data via the CLI:/p>p>code>./blockchyp -test -terminal"Test Terminal" -type"enroll" -firstName"Erlich" -lastName"Bachman" -companyName"Aviato"/code>/p>div classcenter-column>Response:{ success: true, error: , responseDescription: approved, approved: true, authCode: 156580, authResponseCode: 00, transactionId: BHR26QRF7EI6ZB2KVTPEQAAREI, transactionType: enroll, timestamp: 2021-10-05T18:55:46Z, tickBlock: 0000d8b23edb084a946aa9d9186a2f08cc579634680d9849d6ac730234106e8f, test: true, token: XTABANWPEFEX56MFLI2GICLM4E, entryMethod: CHIP, paymentType: VISA, maskedPan: ************0010, cardHolder: UAT USA/Test Card 04, expMonth: 12, expYear: 22, avsResponse: , receiptSuggestions: { aid: A0000000031010, arqc: DBFAF510B448AF6B, iad: 06010A03A0B800, tvr: 8000008800, tsi: 6800, merchantName: Test Merchant, applicationLabel: VISA CREDIT, requestSignature: false, maskedPan: ************0010, authorizedAmount: , transactionType: enroll, entryMethod: CHIP, cvmUsed: No CVM }, customer: { id: BHR26TBF7EI6ZB2KVTPEQAAREI, customerRef: , firstName: Erlich, lastName: Bachman, companyName: Aviato, emailAddress: , smsNumber: , paymentMethods: null }}/div>h2 idlocating-customers-by-payment-method>Locating Customers By Payment Method/h2>p>If a payment method has been tokenized and linked to a customer record, customerinformation is returned automatically with any subsequent payment transactions ifthe payment method is used again. This information is returned automatically as part of the AuthorizationResponse. There are no special parameters requiredto enable it./p>p>This is a great way of determining when you have a returning customer, as seen in the following example:/p>p>code>./blockchyp -test -terminal"Test Terminal" -type"charge" -amount"5.00"/code>/p>div classcenter-column>{ success: true, error: , responseDescription: approved, approved: true, authCode: 585893, authResponseCode: approved, transactionId: BHR26YBF7EI6ZB2KVTPEQAAREI, batchId: XK4LRSBF6II6ZB7TVTPEQAAREI, transactionType: charge, timestamp: 2021-10-05T19:00:49Z, tickBlock: 0000d8b23edb084a946aa9d9186a2f08cc579634680d9849d6ac730234106e8f, test: true, partialAuth: false, altCurrency: false, fsaAuth: false, currencyCode: USD, requestedAmount: 5.00, authorizedAmount: 5.00, remainingBalance: , tipAmount: 0.00, taxAmount: 0.00, requestedCashBackAmount: 0.00, authorizedCashBackAmount: 0.00, entryMethod: CHIP, paymentType: VISA, maskedPan: ************0010, cardHolder: UAT USA/Test Card 04, expMonth: 12, expYear: 22, avsResponse: , receiptSuggestions: { aid: A0000000031010, arqc: 55B76226D9479A19, iad: 06010A03A0B800, tvr: 8000008800, tsi: 6800, merchantName: Test Merchant, applicationLabel: Visa Credit, requestSignature: false, maskedPan: ************0010, authorizedAmount: 5.00, transactionType: charge, entryMethod: CHIP, cvmUsed: No CVM, cashBackAmount: 0.00, surcharge: 0.00, cashDiscount: 0.00 }, customer: { id: BHR26TBF7EI6ZB2KVTPEQAAREI, customerRef: MYID, firstName: Erlich, lastName: Bachman, companyName: Aviato, emailAddress: , smsNumber: , paymentMethods: null }, whiteListedCard: null, storeAndForward: false}/div>h2 idretrieving-customers>Retrieving Customers/h2>p>Customer records, once created, can be retrieved via search and by ID./p>h3 idsearching-customer-records>Searching Customer Records/h3>p>The customer search API executes a simple fuzzy search against the customer database.All that's needed is to pass in query text and the search will match against the customer's first name, last name, company name, or sms number./p>p>Customer search is supported by all languages SDK's including the CLI:/p>p>code>./blockchyp -test -type"search-customer" -query"erlich"/code>/p>div classcenter-column>Response:{ success: true, error: , responseDescription: , customers: { id: BHR26TBF7EI6ZB2KVTPEQAAREI, customerRef: , firstName: Erlich, lastName: Bachman, companyName: Aviato, emailAddress: , smsNumber: , paymentMethods: null } }/div>aside classwarning>Note that payment method information is not returned with customer search results.For payment methods associated with a customer record, use the retreive customer APIdescribed below./aside>h3 idretrieving-a-single-customer-record>Retrieving a Single Customer Record/h3>p>Detailed customer records can be retrieved individually by customer id or customer ref although we recommend you use customer id. (It's a tiny bit faster and there's a guarantee that customer ids are never duplicated.)/p>p>Here's a CLI based example:/p>p>code>./blockchyp -test -type"get-customer" -customerId"BHR26TBF7EI6ZB2KVTPEQAAREI"/code>/p>div classcenter-column>Response:{ success: true, error: , responseDescription: , customer: { id: BHR26TBF7EI6ZB2KVTPEQAAREI, customerRef: , firstName: Erlich, lastName: Bachman, companyName: Aviato, emailAddress: , smsNumber: , paymentMethods: { token: XTABANWPEFEX56MFLI2GICLM4E, maskedPan: ************0010, expiryMonth: 12, expiryYear: 2022, paymentType: VISA, customers: null } }}/div>p>Customer records will include information about every saved payment token associatedwith the customer record, which you can use for payment transactions./p>h3 idretrieving-token-metadata>Retrieving Token Metadata/h3>p>Developers can also look up save payment metadata, including associated customerrecords, by token./p>p>Here's a CLI based example:/p>p>code>./blockchyp -test -type"token-metadata" -token"XTABANWPEFEX56MFLI2GICLM4E"/code>/p>div classcenter-column>Response:{ success: true, error: , responseDescription: , token: { token: XTABANWPEFEX56MFLI2GICLM4E, maskedPan: ************0010, expiryMonth: 12, expiryYear: 12, paymentType: VISA, customers: { id: BHR26TBF7EI6ZB2KVTPEQAAREI, customerRef: , firstName: Erlich, lastName: Bachman, companyName: Aviato, emailAddress: , smsNumber: , paymentMethods: null } }}/div>p>This API is fairly self-explanatory, but note that customer information is returnedas an array because it is possible for a token to be linked to multiple customer recordsat once./p>p>The customer records returned are based on the underlying payment method, not the specifictoken, so if a card has been tokenized more than once, every customer linked to the same underlying card will be returned./p>h2 idmodifying-token-customer-associations>Modifying Token Customer Associations/h2>p>Special APIs are provided for manually changing the associations or links between tokens and customers. Tokens can be linked or unlinked at will./p>h3 idunlink-tokens>Unlink Tokens/h3>p>This API allows developers to break a relationship between a token and a customerrecord. Here's a basic CLI example.../p>p>code>./blockchyp -test -type"unlink-token" -token"N2DTGDSSZNBAX7GT5HBZPHIOWA" -customerId"XK4LRXBF6II6ZB7WVTPEQAAREI"/code>/p>div classcenter-column>Response:{ success: true, error: , responseDescription: ,}/div>aside classwarning>Unlinking a token does not delete the token. It just breaks the relationshipbetween the token and a customer record./aside>h3 idlink-tokens>Link Tokens/h3>p>This API allows developers to add an association between a token and a customer. Ifthe link already exists, the request is ignored./p>p>Here's a basic CLI example.../p>p>code>./blockchyp -test -type"link-token" -token"N2DTGDSSZNBAX7GT5HBZPHIOWA" -customerId"XK4LRXBF6II6ZB7WVTPEQAAREI"/code>/p>div classcenter-column>Response:{ success: true, error: , responseDescription: ,}/div>h2 idremoving-customers-and-tokens>Removing Customers and Tokens/h2>p>Nobody likes to lose customers, but when it does happen, the token and customer delete APIs are here to help you facilitate the inevitable./p>h3 iddelete-customers>Delete Customers/h3>p>The delete customer API will remove a customer record from the system./p>p>It will not remove customer ref information from any historical transactions and it will not automatically delete tokens associated with the customer./p>p>Here's a basic CLI example:/p>p>code>./blockchyp -test -type"delete-customer" -customerId"BHR26TBF7EI6ZB2KVTPEQAAREI"/code>/p>div classcenter-column>Response:{ success: true, error: , responseDescription: ,}/div>h3 iddelete-tokens>Delete Tokens/h3>p>The delete token API removes payment tokens from the system permanently. /p>p>Here's a CLI example:/p>p>code>./blockchyp -test -type"delete-token" -tokenXTABANWPEFEX56MFLI2GICLM4E/code>/p>div classcenter-column>Response:{ success: true, error: , responseDescription: ,}/div>h1 idaddress-verification>Address Verification/h1>blockquote>p>Sample address verification response:/p>/blockquote>pre classhighlight json tab-json>code>span classw> /span>span classp>{/span>span classw> /span>span classs2>success/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>error/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>responseDescription/span>span classp>:/span>span classw> /span>span classs2>approved/span>span classp>,/span>span classw> /span>span classs2>approved/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>authCode/span>span classp>:/span>span classw> /span>span classs2>399232/span>span classp>,/span>span classw> /span>span classs2>transactionId/span>span classp>:/span>span classw> /span>span classs2>CMKSTBUOHAI6VG24AJBKYEIAAM/span>span classp>,/span>span classw> /span>span classs2>batchId/span>span classp>:/span>span classw> /span>span classs2>746LP4EOFMI6VH4UAJBKYEIAAU/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>charge/span>span classp>,/span>span classw> /span>span classs2>timestamp/span>span classp>:/span>span classw> /span>span classs2>2020-05-05T04:49:10Z/span>span classp>,/span>span classw> /span>span classs2>tickBlock/span>span classp>:/span>span classw> /span>span classs2>000e11877145009475a84197f4bd0fd1414a71b5f9690fd41b39a7ad21d9108d/span>span classp>,/span>span classw> /span>span classs2>test/span>span classp>:/span>span classw> /span>span classkc>true/span>span classp>,/span>span classw> /span>span classs2>partialAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>altCurrency/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>fsaAuth/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>currencyCode/span>span classp>:/span>span classw> /span>span classs2>USD/span>span classp>,/span>span classw> /span>span classs2>requestedAmount/span>span classp>:/span>span classw> /span>span classs2>50.00/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>50.00/span>span classp>,/span>span classw> /span>span classs2>remainingBalance/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>tipAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>taxAmount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>requestedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>authorizedCashBackAmount/span>span classp>:/span>span classw> /span>span classs2>/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>KEYED/span>span classp>,/span>span classw> /span>span classs2>paymentType/span>span classp>:/span>span classw> /span>span classs2>VISA/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************1111/span>span classp>,/span>span classw> /span>span classs2>avsResponse/span>span classp>:/span>span classw> /span>span classs2>match/span>span classp>,/span>span classw> /span>span classs2>receiptSuggestions/span>span classp>:/span>span classw> /span>span classp>{/span>span classw> /span>span classs2>merchantName/span>span classp>:/span>span classw> /span>span classs2>CLI Regression Test/span>span classp>,/span>span classw> /span>span classs2>requestSignature/span>span classp>:/span>span classw> /span>span classkc>false/span>span classp>,/span>span classw> /span>span classs2>maskedPan/span>span classp>:/span>span classw> /span>span classs2>************1111/span>span classp>,/span>span classw> /span>span classs2>authorizedAmount/span>span classp>:/span>span classw> /span>span classs2>50.00/span>span classp>,/span>span classw> /span>span classs2>transactionType/span>span classp>:/span>span classw> /span>span classs2>charge/span>span classp>,/span>span classw> /span>span classs2>entryMethod/span>span classp>:/span>span classw> /span>span classs2>KEYED/span>span classp>,/span>span classw> /span>span classs2>surcharge/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classp>,/span>span classw> /span>span classs2>cashDiscount/span>span classp>:/span>span classw> /span>span classs2>0.00/span>span classw> /span>span classp>},/span>span classw> /span>span classs2>customer/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>whiteListedCard/span>span classp>:/span>span classw> /span>span classkc>null/span>span classp>,/span>span classw> /span>span classs2>storeAndForward/span>span classp>:/span>span classw> /span>span classkc>false/span>span classw> /span>span classp>}/span>span classw>/span>/code>/pre>p>Address Verification usually doesn't factor much into terminal based transactions,but it's still an important backstop against fraud when working with manually enteredcards and e-commerce transactions./p>p>Developers have the option at any time to add address verification to a transactionand void or reverse the transaction if they're unhappy with the result./p>p>To use the address verification system, pass a code>postalCode/code> or code>address/code> into anyauthorization transaction. The response will have an code>avsResponse/code> field with a codeindicating the AVS status./p>p>The possible status codes returned would be the following./p>ul>li>strong>not_supported:/strong> Indicates that AVS is not supported for some reason, either technical or related to the payment type./li>li>strong>retry/strong>: Inconclusive response. Try again./li>li>strong>no_match/strong>: No provided postal code or address information matched./li>li>strong>zip_matched/strong>: The postal code matched./li>li>strong>address_match/strong>: The address matched./li>li>strong>match/strong>: Both address and postal code matched./li>/ul>p>strong>Testing Address Verification/strong>/p>p>For testing purposes, nearly all valid zip codes and addresses return as a match./p>p>There are a few special zip codes and addresses that can be used to triggerother responses as listed on the table below:/p>table>thead>tr>th>Response Code/th>th>Trigger Criteria/th>/tr>/thead>tbody>tr>td>not_supported/td>td>Postal Code: 85360/td>/tr>tr>td>no_match/td>td>Postal Code: 73038/td>/tr>tr>td>no_match/td>td>Address: 1701 Page Mill Road/td>/tr>/tbody>/table>h1 idstandard-codes>Standard Codes/h1>p>BlockChyp has a set of standard strings for things like Card Types and Entry Methods./p>p>If there were industry wide standards for this sort of thing, BlockChyp would gladly embrace them, but unfortunately that’s not the way things work. The lists below enumerate the keys you’ll need to bake into your system as constants for BlockChyp./p>h2 idcard-types>Card Types/h2>p>This list enumerates the codes for card types and payment methods./p>table>thead>tr>th>Code/th>th>Card Type/th>/tr>/thead>tbody>tr>td>VISA/td>td>Visa/td>/tr>tr>td>MC/td>td>MasterCard/td>/tr>tr>td>AMEX/td>td>American Express/td>/tr>tr>td>DISC/td>td>Discover/td>/tr>tr>td>DINERS/td>td>Diners Club International/td>/tr>tr>td>CUP/td>td>China Union Pay/td>/tr>tr>td>JCB/td>td>Japan Card Bureau/td>/tr>tr>td>DEBIT/td>td>Debit/td>/tr>tr>td>EBT/td>td>EBT (Electronic Benefits Transfer)/td>/tr>tr>td>BC_GIFT/td>td>BlockChain Gift Card/td>/tr>/tbody>/table>h2 identry-methods>Entry Methods/h2>p>This list enumerates the codes for entry methods./p>table>thead>tr>th>Code/th>th>Entry Method/th>/tr>/thead>tbody>tr>td>CHIP/td>td>EMV Chip Contact/td>/tr>tr>td>CONTACTLESS_EMV/td>td>EMV Contactless/td>/tr>tr>td>ECOM/td>td>E-Commerce/td>/tr>tr>td>KEYED/td>td>Manually Entered/td>/tr>tr>td>SWIPE/td>td>Swiped/td>/tr>tr>td>TOKEN/td>td>Token/td>/tr>/tbody>/table>h1 idrest-api-reference>REST API Reference/h1>p>We recommend developers use SDKs instead of the REST APIs directly as it will make implementation go faster. Our SDKs deal with HMAC authentication and locating terminals for you. But, if you prefer to do a direct REST API integration, we won't stop you. The REST APIs aren't complicated./p>p>BlockChyp consists of two REST APIs: the small API that runs on every BlockChyp payment terminal and the Gateway API./p>h2 idgateway-api>Gateway API/h2>p>Like everything in BlockChyp, the Gateway was designed to be simple. With a few exceptions, the concepts should be familiar to anyone who's done a previous payment gateway implementation./p>h3 idendpoints>Endpoints/h3>p>Per PCI requirements, BlockChyp uses completely separate systems for live and test transactions. Make sure you route test and live transactions to the correct endpoints as given below:/p>table>thead>tr>th>Environment/th>th>Endpoint/th>/tr>/thead>tbody>tr>td>strong>Live Transactions/strong>/td>td>https://api.blockchyp.com/td>/tr>tr>td>strong>Test Transaction/strong>/td>td>https://test.blockchyp.com/td>/tr>/tbody>/table>h3 ida-sample-transaction>A Sample Transaction/h3>p>Let's dive into a sample API request. The sample shows a conventional charge transaction using a previously enrolled recurring payment token./p>p>This example shows the mechanics of a simple token based transaction using the common VISA test card number of 4111 1111 1111 1111./p>div classcenter-column>Request:POST /api/charge HTTP/1.1Host: api.blockchyp.comNonce: HHU8JX48KKX8AYHENKRYMJ5MB6YHM43GHWW7VDRJQDVY0YTBWRGGAuthorization: Dual PCZFLPXD2PWI7B7VVFHD4VJ4KE:NNSNQ6ASHUHSCMEVOD666VZZLA:b695b1af23f9d1ce2983f1f69237866b7fa69878dcdc873ed3507374d8c0508bTimestamp: 2018-12-10T18:07:15Z{transactionRef: 2Q9M727KXH1UYAH57ZV009HGKWXX704URY2GRUPV39MVF27FUFDG,amount:25.23,token:JTLQJNLSM4IGCKJC2MK7COW2VA}Response:HTTP/1.1 200 OK{ transactionRef: 2Q9M727KXH1UYAH57ZV009HGKWXX704URY2GRUPV39MVF27FUFDG, approved:true, responseDescription:Approved, transactionId:LA76MWH4UYI6RGOTNSLM7WZLHE, batchId:F2FGMPX2LEI6RBPSNSLM7WZLHE, transactionType:charge, timestamp:2018-12-10T18:07:15Z, tickBlock:000a40ada947bd35886f19c8908cd84e521f713cc2637c0bf70b3b2ea63ffe7d, authCode:404739, entryMethod:KEYED, paymentType:VISA, maskedPan:************1111, partialAuth:false, altCurrency:false, currencyCode:USD, requestedAmount:25.23, authorizedAmount:25.23, tipAmount:0.00, taxAmount:0.00, receiptSuggestions:{ requestSignature:false }}/div>p>transactionRef is where you would provide your own ID for a transaction. It's not required, but highly recommended because it allows you to track responses against your own ID scheme, and more importantly, time out reversals are not supported unless you provide a transactionRef value./p>p>Most notable in this sample request are the three headers used by BlockChyp's Dual authentication scheme (Timestamp, Nonce, and Authorization)./p>h3 idauthentication-headers>Authentication Headers/h3>p>BlockChyp credentials take the form of an strong>API Key/strong>, a strong>Bearer Token/strong>, and a strong>Signing Key/strong>- and are generated by the BlockChyp dashboard. These three credentials are used to assemble the Authorization header./p>p>Gateway API requests are protected using a combination of Bearer Tokens and HMAC headers. The reason for this is that HMAC headers and Bearer Tokens provide offsetting security benefits./p>p>For example, Bearer Tokens can be stored in the BlockChyp datastore as salted one way hashes which protects them in the event of a database breach. But Bearer Tokens must be sent over the network with every request where they might be vulnerable to interception in the event of a TLS or SSL vulnerability./p>p>To offset this risk, we also require every API request include a digital signature in the form of an HMAC value computed via the Signing Key. Since HMAC signatures change forevery request, they are of no value to a hacker, even if intercepted./p>p>All API requests require the following three headers:/p>p>strong>Nonce/strong>/p>p>Example Header:/p>p>code>Nonce: HHU8JX48KKX8AYHENKRYMJ5MB6YHM43GHWW7VDRJQDVY0YTBWRGG/code>/p>p>This header should be a unique string with a minimum length of 16 characters. Developers are encouraged to use a cryptographically secure random number generator to produce nonces. Nonces are checked for uniqueness in real time./p>p>The Nonce has to be sent in its own header as shown above and also must be fed into the HMAC computation as part of the Authorization header./p>p>strong>Timestamp/strong>/p>p>Example Header:/p>p>code>Timestamp: 2018-12-10T18:07:15Z/code>/p>p>This header should be the ISO 8601 formatted timestamp at the time the transaction is executed in UTC. The timestamp must be within 10 minutes of the current time or the gateway will reject the transaction./p>p>strong>Authorization/strong>/p>p>Example Header:/p>p>code>Authorization: Dual PCZFLPXD2PWI7B7VVFHD4VJ4KE:b695b1af23f9d1ce2983f1f69237866b7fa69878dcdc873ed3507374d8c0508b/code>/p>p>code>Authorization: Dual <Bearer Token>:<API Key>:<HMAC Signature>/code>/p>p>The authorization header is assembled by starting with the keyword "Dual" which references BlockChyp's Dual authentication scheme./p>p>Add a space and then the Bearer Token followed by the API Key, separated by a colon./p>p>To compute the HMAC Signature, first concatenate the API Key, Bearer Token, Timestamp and Nonce with no separator. (We've kept the canonical message to be signed a bit simpler than other HMAC implementations in order to make implementation accessible to developers of all skill levels.)/p>p>Next, compute an SHA 256 HMAC with the Signing Key and encode it as a hexadecimal string./p>p>The sample code below shows how to compute an HMAC value in the Go Language./p>p>strong>Go Language HMAC Example:/strong>/p>div classcenter-column>import ( bytes crypto/hmac crypto/sha256 encoding/hex)/*ComputeHmac computes an hmac for the the given headers and secret key.*/func ComputeHmac(APIKey, bearerToken, timestamp, nonce, signingKey string) string { buf : bytes.Buffer{} buf.WriteString(APIKey) buf.WriteString(bearerToken) buf.WriteString(timestamp) buf.WriteString(nonce) key, _ : hex.DecodeString(signingKey) mac : hmac.New(sha256.New, key) mac.Write(buf.Bytes()) hash : mac.Sum(nil) return hex.EncodeToString(hash)}/div>aside classwarning>b>Note/b>p>HMAC headers are usually the hardest part of an implementation to get right. We recommend that developers doing direct REST implementations start by writing an integration test against the Heartbeat API described next./p>/aside>h3 idheartbeat-api-heartbeat>Heartbeat (/api/heartbeat)/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>GET/td>td>/api/heartbeat/td>/tr>/tbody>/table>p>This endpoint is used to test connectivity with the Gateway and get updated time reference information. This API will return a response even if the big three authentication headers are not provided so it's usually a good API to start an implementation with./p>p>If a valid Authorization header is provided, this API will also return the Blockchain public key of the merchant. This is a simple GET request and accepts no path or query string parameters./p>p>The heartbeat response includes the latest Gateway Timestamp, the latest tick block for the Blockchain and if your Authorization headers are valid, the Blockchain Public Key of the merchant./p>p>We recommend you write an integration test that ensures that merchantPk is non-null as a way to test your Authorization and HMAC implementation./p>p>strong>Sample Request and Response:/strong>/p>div classcenter-column>Request:GET /api/heartbeat HTTP/1.1Host: api.blockchyp.comNonce: HHU8JX48KKX8AYHENKRYMJ5MB6YHM43GHWW7VDRJQDVY0YTBWRGGAuthorization: Dual PCZFLPXD2PWI7B7VVFHD4VJ4KE:NNSNQ6ASHUHSCMEVOD666VZZLA:b695b1af23f9d1ce2983f1f69237866b7fa69878dcdc873ed3507374d8c0508bTimestamp: 2018-12-10T18:07:15ZResponse:HTTP/1.1 200 OK{success: true,timestamp: 2018-12-10T11:16:06.2246-08:00,latestTick: 000a40ada947bd35886f19c8908cd84e521f713cc2637c0bf70b3b2ea63ffe7d,merchantPk: 145kEAfQUj619jC1hbpegu1DprnYhoaqikXeCgcX8ZoXPi5oE8t}/div>h3 idterminal-route-api-terminal-route>Terminal Route (/api/terminal-route)/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>GET/td>td>/api/terminal-route/td>/tr>/tbody>/table>table>thead>tr>th>Query String Parameter/th>th>Description/th>th>Required/th>/tr>/thead>tbody>tr>td>terminal/td>td>Name assigned to the terminal at activation/td>td>Yes/td>/tr>/tbody>/table>p>This API is used to get current metadata about BlockChyp terminals including the terminal's IP Address on the private network along with transient credentials and blockchain public key information./p>p>We strongly recommend that payment terminals be configured with static IP addresses, but we also understand that real life point-of-sale or merchant networks can be chaotic environments where recommendations aren't always followed./p>p>This API is part of a set of techniques BlockChyp uses to try and cope with real world merchant networks. Terminals check in with the BlockChyp network when they're activated and periodically throughout the day. They report their IP address on the private network along with some internal metrics used to monitor the overall health of the network and for fraud detection./p>p>The Terminal Route API can be used to lookup a terminal's IP Address by the name assigned to the terminal at activation. It serves as a simple DNS system for terminals and makes merchant networks more robust, even if all terminals are left on the default DHCP settings./p>div classcenter-column>Request:GET /api/terminal-route?terminalCashier%20#1 HTTP/1.1Host: api.blockchyp.comAuthorization: Dual JTLQJNLSM4IGCKJC2MK7COW2VA:CINR73MIHX337KMRHW7BI5I2AM:7721b505f6cc4540e471d03e42388e3a5a1567b29dedf589ef881995e9ca74ccNonce: MNAYY7YCXME215ZBZ96BW7D1JFPX5VBX563EGAGH4E6KA8RV8BE0Timestamp: 2018-11-20T18:04:25ZResponse:HTTP/1.1 200 OK{ success: true, terminalName: Cashier #1, ipAddress: 192.168.50.245, cloudRelayEnabled: false, transientCredentials: { apiKey: CINR73MIHX337KMRHW7BI5I2AM, bearerToken: JTLQJNLSM4IGCKJC2MK7COW2VA, signingKey: c7722b911f9821e742f248af8449f12f06304c18b48b902f7cdef3d9dea7ed34 }, publicKey: 112hvhQwGa22QJSuqZwdMT5BhBNcrE9pwfHzFicx4ZMLkAe6chRi, rawKey: { curve: P256, x: e09f8673361cc828cda624221d5f2b517c4c4285d959e502511b531f324ece0a, y: cced17b1d95dcbcc5bf2b2f06ba4bdb4b482bd0e081ac54fb49b6db2ab40a5b4 }}/div>p>The JSON response includes the following data elements that might require a bit of explanation:/p>table>thead>tr>th>Field/th>th>Description/th>/tr>/thead>tbody>tr>td>strong>ipAddress/strong>/td>td>The current local IP address of the terminal on the private network. If the point-of-sale or client application is on the same network as the terminal, the terminal's REST API can be found at ports 8080 and 8443 at the given IP Address./td>/tr>tr>td>strong>cloudRelayEnabled/strong>/td>td>Indicates that this terminal is accessible via the Gateway. Not recommended, but unavoidable if the point-of-sale system and terminal are on different network segments./td>/tr>tr>td>strong>transientCredentials/strong>/td>td>Special credentials restricted for use only with the given terminal. All direct API calls to terminals should use these credentials, especially if the merchants are unable to run TLS/SSL on their local network./td>/tr>tr>td>strong>publicKey/strong>/td>td>The blockchain public key for the terminal in BlockChyp's compressed key format. Can be used to validate the signatures of terminal responses./td>/tr>tr>td>strong>rawKey/strong>/td>td>The raw version of the terminal's blockchain public key. Includes the name of the standard elliptic curve (usually P256) and the raw x and y coordinates of the public key in hexadecimal format./td>/tr>/tbody>/table>h3 idterminal-ping-api-terminal-test>Terminal Ping ( /api/terminal-test )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/terminal-test/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This simple test transaction helps ensure good communication with a payment terminal and is usually the first test you'll run in development./p>p>It tests communication with the terminal and returns a positive response if everythingis okay. It works the same way in local or cloud relay mode./p>p>If you get a positive response, you've successfully verified all of the following:/p>ul>li>The terminal is online./li>li>There is a valid route to the terminal./li>li>The API Credentials are valid./li>/ul>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/test HTTP/1.1Host: test.blockchyp.comAuthorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:a8da5aa7ba6518b2ec392b3f7a221c5357b00163e0845bfbd769d161aa3c1effNonce: 3f915730b23a513342f667a4725e67fa373666e9341afec47e3c7fcb7ab5224dTimestamp: 2021-05-20T17:56:00Z{test: true,timeout: 120,terminalName: Test Terminal}Response:HTTP/1.1 200 OK{ success:true, errorMessage:}/div>h3 idterminal-locate-api-terminal-locate>Terminal Locate ( /api/terminal-locate )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/terminal-locate/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This endpoint returns a terminal's routing and location information./p>p>The result will indicate whether or not the terminal is in cloud relay mode and willreturn the local IP address if the terminal is in local mode./p>p>The terminal will also return the public key for the terminal./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/terminal-locate HTTP/1.1Host: test.blockchyp.comAuthorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:a8da5aa7ba6518b2ec392b3f7a221c5357b00163e0845bfbd769d161aa3c1effNonce: 3f915730b23a513342f667a4725e67fa373666e9341afec47e3c7fcb7ab5224dTimestamp: 2021-05-20T17:56:00Z{ test: true, timeout: 120, terminalName: Test Terminal}Response:HTTP/1.1 200 OK{ success:true, errorMessage:, terminalName: Test Terminal, cloudRelay: false, ipAddress: 127.0.0.1, publicKey: 11pJMoWkjq1dHZcQp1P6apTk7J3QsoD9rtYW877c3BfJhDr8ozf}/div>h3 idcharge-api-charge>Charge ( /api/charge )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/charge/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>Our most popular transaction executes a standard authorization and capture.This is the most basic ofbasic payment transactions, typically used in conventional retail./p>p>Charge transactions can use a payment terminal to capture a payment oruse a previously enrolled payment token./p>p>strong>Terminal Transactions/strong>/p>p>For terminal transactions, make sure you pass in the terminal name using the code>terminalName/code> property./p>p>strong>Token Transactions/strong>/p>p>If you have a payment token, omit the code>terminalName/code> property and pass in the token with the code>token/code>property instead./p>p>strong>Card Numbers and Mag Stripes/strong>/p>p>You can also pass in PANs and Mag Stripes, but you probably shouldn't, as this willput you in PCI scope and the most common vector for POS breaches is keylogging.If you use terminals for manual card entry, you'll bypass any keyloggers thatmight be maliciously running on the point-of-sale system./p>p>strong>Common Variations/strong>/p>ul>li>strong>Gift Card Redemption/strong>: There's no special API for gift card redemption in BlockChyp. Simply execute a plain charge transaction and if the customer swipes a gift card, our terminals will identify the gift card and run a gift card redemption. Also note that if for some reason the gift card's original purchase transaction is associated with fraud or a chargeback, the transaction will be rejected./li>li>strong>EBT/strong>: Set the code>CardType/code> field to code>blockchyp.CardTypeEBT/code> to process an EBT SNAP transaction. Note that test EBT transactions always assume a balance of $100.00, so test EBT transactions over that amount may be declined./li>li>strong>Cash Back/strong>: To enable cash back for debit transactions, set the code>CashBack/code> field. If the card presented isn't a debit card, the code>CashBack/code> field will be ignored./li>li>strong>Manual Card Entry/strong>: Set the code>ManualEntry/code> field to enable manual card entry. Good as a backup when chips and MSR's don't work or for more secure phone orders. You can even combine the code>ManualEntry/code> field with the code>CardType/code> field set to code>blockchyp.CardTypeEBT/code> for manual EBT card entry./li>li>strong>Inline Tokenization/strong>: You can enroll the payment method in the token vault inline with a charge transaction by setting the code>Enroll/code> field. You'll get a token back in the response. You can even bind the token to a customer record if you also pass in customer data./li>li>strong>Prompting for Tips/strong>: Set the code>PromptForTip/code> field if you'd like to prompt the customer for a tip before authorization. Good for pay-at-the-table and other service related scenarios./li>li>strong>Cash Discounting and Surcharging/strong>: The code>Surcharge/code> and code>CashDiscount/code> fields can be used together to support cash discounting or surcharge problems. Consult the Cash Discount documentation for more details./li>li>strong>Cryptocurrency/strong> The code>Cryptocurrency/code> field can be used to switch the standard present card screen to a cryptocurrency screen. The field value can be code>ANY/code> to enable any supported cryptocurrency or a single currency code such as code>BTC/code> for Bitcoin./li>/ul>p>There are two situations in which charge transactions would go directly to the gatewayinstead of to a terminal./p>p>strong>Tokenized Charge Sample Request and Response/strong>/p>p>This example shows how to use a token previously obtained from an enroll transactionor the web tokenizer. Never pass PINs or mag stripe data directly into this API. Alwaysuse terminals or the web tokenizer to capture sensitive card data./p>div classcenter-column>Request:POST /api/charge HTTP/1.1Host: test.blockchyp.comContent-Length: 271Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:9f52ddd8d111b26159a9b57fbda58c00e45591dc5c60ff8705a88b91eeca383fNonce: 8d2506a16d2a176bb9b884754a62c7a2540f29a1efe9d08fac37577f232c996bTimestamp: 2021-05-20T15:43:34Z{ test: true, timeout: 120, token: Z4OCUYD7OPLY5KHMSUBE25THDU, amount: 42.00}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: approved, approved: true, authCode: 765077, transactionId: 2RISGQ5ZQEI6XKWGAJBKYEIAAQ, batchId: UM4CKCFYVMI6XJY6AJBKYEIAAI, transactionType: charge, timestamp: 2021-05-20T15:43:34Z, tickBlock: 00065e5bb121723c9c3e752044ea662231c9f09c45fc514996adc86c4e22665e, test: true, partialAuth: false, altCurrency: false, fsaAuth: false, currencyCode: USD, requestedAmount: 42.00, authorizedAmount: 42.00, remainingBalance: , tipAmount: 0.00, taxAmount: 0.00, requestedCashBackAmount: , authorizedCashBackAmount: , entryMethod: TOKEN, paymentType: MC, maskedPan: ************4111, receiptSuggestions: { merchantName: CLI Regression Test, requestSignature: false, maskedPan: ************4111, authorizedAmount: 42.00, transactionType: charge, entryMethod: TOKEN, surcharge: 0.00, cashDiscount: 0.00 }}/div>p>strong>Cloud Relay Sample Request and Response/strong>/p>p>This example shows how to start a charge transaction on a terminal via cloud relay./p>div classcenter-column>Request:GATEWAY REQUEST:POST /api/charge HTTP/1.1Host: test.blockchyp.comContent-Length: 265Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:981e97f99a2cd3e18b522ae06f86075548393fcb1794b594f738764fa2290a87Nonce: 8409f7976c1a0ad7464ce859e158c363282d5de0e15369fbcb6c5a7fcb316576Timestamp: 2021-05-20T15:45:27Z{ test: true, timeout: 120, amount: 42.00, terminalName: Test Terminal}Response:{ success: true, error: , responseDescription: approved, approved: true, authCode: 334066, transactionId: 2RISGRNZQEI6XKWGAJBKYEIAAQ, batchId: UM4CKCFYVMI6XJY6AJBKYEIAAI, transactionType: charge, timestamp: 2021-05-20T15:45:32Z, tickBlock: 00065e5bb121723c9c3e752044ea662231c9f09c45fc514996adc86c4e22665e, test: true, partialAuth: false, altCurrency: false, fsaAuth: false, currencyCode: USD, requestedAmount: 42.00, authorizedAmount: 42.00, remainingBalance: , tipAmount: 0.00, taxAmount: 0.00, requestedCashBackAmount: 0.00, authorizedCashBackAmount: 0.00, entryMethod: CONTACTLESS EMV, paymentType: MC, maskedPan: ************4111, cardHolder: /, expMonth: 12, expYear: 22, avsResponse: , receiptSuggestions: { aid: A0000000041010, arqc: 791B9EF0EE009DBD, iad: 0110A04003220000000000000000000000FF, tvr: 0000008801, merchantName: CLI Regression Test, applicationLabel: MASTERCARD, requestSignature: false, maskedPan: ************4111, authorizedAmount: 42.00, transactionType: charge, entryMethod: CONTACTLESS EMV, cashBackAmount: 0.00, surcharge: 0.00, cashDiscount: 0.00 }}/div>h3 idpreauthorization-api-preauth>Preauthorization ( /api/preauth )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/preauth/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>A preauthorization puts a hold on funds and must be captured later. This is usedin scenarios where the final transaction amount might change. A common example is fine dining, where a tip adjustment is required before final settlement./p>p>Another use case for preauthorization is e-commerce. Typically, an online orderis preauthorized at the time of the order and then captured when the order ships./p>p>Preauthorizations can use a payment terminal to capture a payment oruse a previously enrolled payment token./p>p>strong>Terminal Transactions/strong>/p>p>For terminal transactions, make sure you pass in the terminal name using the code>terminalName/code> property./p>p>strong>Token Transactions/strong>/p>p>If you have a payment token, omit the code>terminalName/code> property and pass in the token with the code>token/code>property instead./p>p>strong>Card Numbers and Mag Stripes/strong>/p>p>You can also pass in PANs and Mag Stripes, but you probably shouldn't, as this willput you in PCI scope and the most common vector for POS breaches is key logging.If you use terminals for manual card entry, you'll bypass any key loggers thatmight be maliciously running on the point-of-sale system./p>p>strong>Cryptocurrency/strong>/p>p>Note that preauths are not supported for cryptocurrency./p>p>strong>Common Variations/strong>/p>ul>li>strong>Manual Card Entry/strong>: Set the code>ManualEntry/code> field to enable manual card entry. Good as a backup when chips and MSR's don't work or for more secure phone orders. You can even combine the code>ManualEntry/code> field with code>CardType/code> set to code>blockchyp.CardTypeEBT/code> for manual EBT card entry./li>li>strong>Inline Tokenization/strong>: You can enroll the payment method in the token vault in line with a charge transaction by setting the code>Enroll/code> field. You'll get a token back in the response. You can even bind the token to a customer record if you also pass in customer data./li>li>strong>Prompting for Tips/strong>: Set the code>PromptForTip/code> field if you'd like to prompt the customer for a tip before authorization. You can prompt for tips as part of a preauthorization, although it's not a very common approach./li>li>strong>Cash Discounting and Surcharging/strong>: The code>Surcharge/code> and code>CashDiscount/code> fields can be used together to support cash discounting or surcharge problems. Consult the Cash Discount documentation for more details./li>/ul>p>strong>Tokenized Charge Sample Request and Response/strong>/p>p>This example shows how to use a token previously obtained from an enroll transactionor the web tokenizer. Never pass PINs or mag stripe data directly into this API. Alwaysuse terminals or the web tokenizer to capture sensitive card data./p>div classcenter-column>Request:POST /api/preauth HTTP/1.1Host: test.blockchyp.comContent-Length: 271Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:bddc368ea70273cb16e763398ce2346ca03e9d47ded5b77a45a1ca3a0958d827Nonce: c22c1486a0a98d3a401c168da55f31f19aa79ff5cfb8ffa15bfda02f663529d9Timestamp: 2021-05-20T15:49:44Z{ test: true, timeout: 120, token: Z4OCUYD7OPLY5KHMSUBE25THDU, amount: 42.00}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: approved, approved: true, authCode: 553917, transactionId: 2RISGR5ZQEI6XKWGAJBKYEIAAQ, batchId: UM4CKCFYVMI6XJY6AJBKYEIAAI, transactionType: preauth, timestamp: 2021-05-20T15:49:44Z, tickBlock: 00065e5bb121723c9c3e752044ea662231c9f09c45fc514996adc86c4e22665e, test: true, partialAuth: false, altCurrency: false, fsaAuth: false, currencyCode: USD, requestedAmount: 42.00, authorizedAmount: 42.00, remainingBalance: , tipAmount: 0.00, taxAmount: 0.00, requestedCashBackAmount: , authorizedCashBackAmount: , entryMethod: TOKEN, paymentType: MC, maskedPan: ************4111, avsResponse: , receiptSuggestions: { merchantName: CLI Regression Test, requestSignature: false, maskedPan: ************4111, authorizedAmount: 42.00, transactionType: preauth, entryMethod: TOKEN, surcharge: 0.00, cashDiscount: 0.00 }}/div>p>strong>Cloud Relay Sample Request and Response/strong>/p>p>This example shows how to start a preauth transaction on a terminal via cloud relay./p>div classcenter-column>Request:POST /api/preauth HTTP/1.1Host: test.blockchyp.comContent-Length: 265Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:233f878bf889f89dc43786e286719950b777c3311bc39571e52aea24f1f9ca53Nonce: 4ddf61582525f84c0d314c925794aaa579dc09ce5de402678ec50ff3b6465a8cTimestamp: 2021-05-20T15:52:44Z{ test: true, timeout: 120, amount: 42.00, terminalName: Test Terminal}Response:{ success: true, error: , responseDescription: approved, approved: true, authCode: 988388, transactionId: UM4CKEFYVMI6XJY6AJBKYEIAAI, batchId: UM4CKCFYVMI6XJY6AJBKYEIAAI, transactionType: preauth, timestamp: 2021-05-20T15:52:48Z, tickBlock: 00065e5bb121723c9c3e752044ea662231c9f09c45fc514996adc86c4e22665e, test: true, partialAuth: false, altCurrency: false, fsaAuth: false, currencyCode: USD, requestedAmount: 42.00, authorizedAmount: 42.00, remainingBalance: , tipAmount: 0.00, taxAmount: 0.00, requestedCashBackAmount: 0.00, authorizedCashBackAmount: 0.00, entryMethod: SWIPE, paymentType: DISC, maskedPan: ************1117, cardHolder: BACHMAN/ERLICH, expMonth: 12, expYear: 25, avsResponse: , receiptSuggestions: { merchantName: CLI Regression Test, requestSignature: false, maskedPan: ************1117, authorizedAmount: 42.00, transactionType: preauth, entryMethod: SWIPE, cashBackAmount: 0.00, surcharge: 0.00, cashDiscount: 0.00 }}/div>h3 idcapture-preauthorization-api-capture>Capture Preauthorization ( /api/capture )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/capture/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API allows you to capture a previously approved preauthorization./p>p>You'll need to make sure you pass in the Transaction ID returned by the original preauth transaction so we know which transaction we're capturing. If you want to capture the transaction for theexact amount of the preauth, the Transaction ID is all you need to pass in./p>p>You can adjust the total if you need to by passing in a new code>amount/code>. Wealso recommend you pass in updated amounts for code>tax/code> and code>tip/code> as it cansometimes reduce your interchange fees. (Level II Processing, for example.)/p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/capture HTTP/1.1Host: test.blockchyp.comContent-Length: 227Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:1156929cee1a8e322cdcbeb0ea217c66cdcb09db4ea9d6798b7c9a68c25fca00Nonce: 05b96fb6f828ea5dbe72da54d1dd1c3476188a6c8e280b5ab122f9597ec4692dTimestamp: 2021-05-19T21:08:28Z{ test: true, timeout: 120, transactionId: UM4CJZFYVMI6XJY6AJBKYEIAAI, amount: 47.00, tipAmount: 5}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: approved, approved: true, authCode: 954418, transactionId: UM4CJZVYVMI6XJY6AJBKYEIAAI, batchId: NK4XCAVYVMI6XFBOAJBKYEIAAU, transactionType: capture, timestamp: 2021-05-19T21:08:29Z, tickBlock: 00086bc6fc219f8f0121af0be188c5d5b32376aae9d23d56366b41a8541788b8, test: true, partialAuth: false, altCurrency: false, fsaAuth: false, currencyCode: USD, requestedAmount: 47.00, authorizedAmount: 47.00, tipAmount: 5.00, taxAmount: 0.00, entryMethod: CHIP, paymentType: VISA, maskedPan: ************0010}/div>h3 idrefund-api-refund>Refund ( /api/refund )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/refund/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>It's not ideal, but sometimes customers want their money back./p>p>Our refund API allows you to confront this unpleasant reality by executing refunds in a few different scenarios./p>p>The most fraud resistent method is to execute refunds in the context of a previous transaction. You should always keep track of the Transaction IDreturned in a BlockChyp response. To refund the full amount of the previous transaction, just pass in the original Transaction ID with the refund requests./p>p>strong>Partial Refunds/strong>/p>p>For a partial refund, just pass in an amount along with the Transaction ID.The only rule is that the amount must be equal to or less than the originaltransaction. You can execute multiple partial refunds against the sameoriginal transaction as long as the total refunded amount doesn't exceed the original amount./p>p>strong>Tokenized Refunds/strong>/p>p>You can also use a token to execute a refund. Pass in a token insteadof the Transaction ID and the desired refund amount./p>p>strong>Free Range Refunds/strong>/p>p>When you execute a refund without referencing a previous transaction, wecall this a em>free range refund/em>./p>p>We don't recommend this type of refund, but it is permitted. If you absolutely insist ondoing it, pass in a Terminal Name and an amount./p>p>You can execute a manual or keyed refund by passing the code>ManualEntry/code> fieldto a free range refund request./p>p>strong>Gift Card Refunds/strong>/p>p>Gift card refunds are allowed in the context of a previous transaction, butfree range gift card refunds are not allowed. Use the gift card activationAPI if you need to add more funds to a gift card./p>p>strong>Store and Forward Support/strong>/p>p>Refunds are not permitted when a terminal falls back to store and forward mode./p>p>strong>Auto Voids/strong>/p>p>If a refund referencing a previous transaction is executed for the full amountbefore the original transaction's batch is closed, the refund is automaticallyconverted to a void. This saves the merchant a little bit of money./p>p>strong>Cryptocurrency/strong>/p>p>Note that refunds are not supported for cryptocurrency. You must refund crypto transactionsmanually from your cryptocurrency wallet./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/refund HTTP/1.1Host: test.blockchyp.comContent-Length: 201Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:df6dccbd378dcee6f5fb7e99391f663cba16a8d25101d32d2c140c9ea5e48fdaNonce: 5775b50fbcf940abc6aaef18b951e971cdd220c30703a01de3aa6dbd63cf5829Timestamp: 2021-05-19T21:14:45Z{ test: true, timeout: 120, transactionId: NK4XCBVYVMI6XFBOAJBKYEIAAU, amount: 12.00}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: approved, approved: true, authCode: 396346, transactionId: NK4XCCNYVMI6XFBOAJBKYEIAAU, batchId: NK4XCAVYVMI6XFBOAJBKYEIAAU, transactionType: refund, timestamp: 2021-05-19T21:16:13Z, tickBlock: 00086bc6fc219f8f0121af0be188c5d5b32376aae9d23d56366b41a8541788b8, test: true, partialAuth: false, altCurrency: false, fsaAuth: false, currencyCode: USD, requestedAmount: 12.00, authorizedAmount: 12.00, remainingBalance: , tipAmount: 0.00, taxAmount: 0.00, entryMethod: CHIP, paymentType: VISA, maskedPan: ************0010, avsResponse: , receiptSuggestions: { merchantName: CLI Regression Test, requestSignature: false, maskedPan: ************0010, authorizedAmount: 12.00, transactionType: refund, entryMethod: CHIP }}/div>p>strong>Cloud Relay Free Range Refund Example/strong>/p>div classcenter-column>Request:POST /api/refund HTTP/1.1Host: test.blockchyp.comContent-Length: 211Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:e09448a799dc519dbee8009d70e50fb700e6748a36d1570c44b70dcdf5afb627Nonce: 795fb7555deab2c078be6ee1e33dd1d6d008555144380ddcbd3c4b311791b023Timestamp: 2021-05-20T15:59:29Z{ test: true, timeout: 120, amount: 12.00, terminalName: Test Terminal}Response:{ success: true, error: , responseDescription: approved, approved: true, authCode: 613828, transactionId: UM4CKEVYVMI6XJY6AJBKYEIAAI, batchId: UM4CKCFYVMI6XJY6AJBKYEIAAI, transactionType: refund, timestamp: 2021-05-20T15:59:38Z, tickBlock: 00065e5bb121723c9c3e752044ea662231c9f09c45fc514996adc86c4e22665e, test: true, partialAuth: false, altCurrency: false, fsaAuth: false, currencyCode: USD, requestedAmount: 12.00, authorizedAmount: 12.00, remainingBalance: , tipAmount: 0.00, taxAmount: 0.00, requestedCashBackAmount: 0.00, authorizedCashBackAmount: 0.00, entryMethod: CHIP, paymentType: VISA, maskedPan: ************0010, cardHolder: UAT USA/Test Card 04, expMonth: 12, expYear: 22, avsResponse: , receiptSuggestions: { aid: A0000000031010, arqc: 5ADCFC0DD5D9049B, iad: 06010A03A0B800, tvr: 8000008800, tsi: 6800, merchantName: CLI Regression Test, applicationLabel: VISA CREDIT, requestSignature: false, maskedPan: ************0010, authorizedAmount: 12.00, transactionType: refund, entryMethod: CHIP, cashBackAmount: 0.00, surcharge: 0.00, cashDiscount: 0.00 }}/div>h3 idenroll-api-enroll>Enroll ( /api/enroll )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/enroll/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API allows you to tokenize and enroll a payment method in the tokenvault. You can also pass in customer information and associate thepayment method with a customer record./p>p>A token is returned in the response that can be used in subsequent charge,preauth, and refund transactions./p>p>strong>Gift Cards and EBT/strong>/p>p>Gift Cards and EBT cards cannot be tokenized./p>p>strong>E-Commerce Tokens/strong>/p>p>The tokens returned by the enroll API and the e-commerce web tokenizerare the same tokens and can be used interchangeably./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/enroll HTTP/1.1Host: test.blockchyp.comContent-Length: 102Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:306560a0aff599f6fc707ebee1e64843dc61df52232e3475717ae07008627bacNonce: e2b20f7b2d19783f438177d654f01fd1b5833635d090e3c4be6d86c1823629c6Timestamp: 2021-05-20T15:41:21Z{ async: false, queue: false, test: true, timeout: 120, terminalName: Test Terminal}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: approved, approved: true, authCode: 063965, transactionId: UM4CKCNYVMI6XJY6AJBKYEIAAI, transactionType: enroll, timestamp: 2021-05-20T15:41:28Z, tickBlock: 00065e5bb121723c9c3e752044ea662231c9f09c45fc514996adc86c4e22665e, test: true, token: Z4OCUYD7OPLY5KHMSUBE25THDU, entryMethod: CHIP, paymentType: MC, maskedPan: ************4111, cardHolder: UAT USA/Test Card 06, expMonth: 12, expYear: 22, avsResponse: , receiptSuggestions: { aid: A0000000041010, arqc: D58BB7C93A5FC5AA, iad: 0110A00003220000000000000000000000FF, tvr: 8000008800, tsi: 6800, merchantName: CLI Regression Test, applicationLabel: MASTERCARD, requestSignature: false, maskedPan: ************4111, authorizedAmount: , transactionType: enroll, entryMethod: CHIP }}/div>h3 idvoid-api-void>Void ( /api/void )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/void/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>Mistakes happen. If a transaction is made by mistake, you can void itwith this API. All that's needed is to pass in a Transaction ID and executethe void before the original transaction's batch closes./p>p>Voids work with EBT and gift card transactions with no additional parameters./p>p>strong>Cryptocurrency/strong>/p>p>Note that voids are not supported for cryptocurrency. You must refund crypto transactionsmanually from your cryptocurrency wallet./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/void HTTP/1.1Host: test.blockchyp.comUser-Agent: Go-http-client/1.1Content-Length: 100Timestamp: 2021-05-19T21:34:02ZAccept-Encoding: gzip{ test: true, timeout: 120, transactionId: UM4CJ25YVMI6XJY6AJBKYEIAAI}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: approved, approved: true, authCode: 246465, transactionId: UM4CJ3NYVMI6XJY6AJBKYEIAAI, batchId: NK4XCAVYVMI6XFBOAJBKYEIAAU, transactionType: void, timestamp: 2021-05-19T21:34:03Z, tickBlock: 00079cc170c50477411b5565a1b0a9bbd92a51d838d7b6a36de107fbd8e986ac, test: true, entryMethod: SWIPE, paymentType: DISC}/div>h3 idcard-metadata-api-card-metadata>Card Metadata ( /api/card-metadata )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/card-metadata/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API allows you to retrieve card metadata./p>p>Card metadata requests can use a payment terminal to retrieve metadata oruse a previously enrolled payment token./p>p>strong>Terminal Transactions/strong>/p>p>For terminal transactions, make sure you pass in the terminal name using the code>terminalName/code> property./p>p>strong>Token Transactions/strong>/p>p>If you have a payment token, omit the code>terminalName/code> property and pass in the token with the code>token/code>property instead./p>p>strong>Card Numbers and Mag Stripes/strong>/p>p>You can also pass in PANs and Mag Stripes, but you probably shouldn't, as this willput you in PCI scope and the most common vector for POS breaches is keylogging.If you use terminals for manual card entry, you'll bypass any keyloggers thatmight be maliciously running on the point-of-sale system./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/card-metadata HTTP/1.1Host: test.blockchyp.comContent-Length: 265Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:981e97f99a2cd3e18b522ae06f86075548393fcb1794b594f738764fa2290a87Nonce: 8409f7976c1a0ad7464ce859e158c363282d5de0e15369fbcb6c5a7fcb316576Timestamp: 2021-05-20T15:45:27Z{ test: true, timeout: 120, terminalName: Test Terminal}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: approved, cardMetadata: { cardBrand: MC, issuerName: Chase Bank USA, l3: false, l2: false, productType: MCC, productName: MCC - Chase credit card, ebt: false, debit: false, healthcare: false, prepaid: false, region: , country: USA }}/div>h3 idtime-out-reversal-api-reverse>Time Out Reversal ( /api/reverse )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/reverse/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>Payment transactions require a stable network to function correctly andno network is stable all the time. Time out reversals are a great lineof defense against accidentally double charging consumers when paymentsare retried during shaky network conditions./p>p>We highly recommend developers use this API whenever a charge, preauth, or refund transaction times out. If you don't receive a definitive responsefrom BlockChyp, you can't be certain about whether or not the transaction went through./p>p>The best practice in this situation is to send a time out reversal request. Time out reversals check for a transaction and void it if it exists./p>p>The only caveat is that developers must use the code>transactionRef/code> property (code>txRef/code> for the CLI) when executing charge, preauth, and refund transactions./p>p>The reason for this requirement is that if a system never receives a definitiveresponse for a transaction, the system would never have received the BlockChypgenerated Transaction ID. We have to fall back to Transaction Ref to identifya transaction./p>p>strong>Cryptocurrency/strong>/p>p>Note that refunds are not supported for cryptocurrency. You must refund crypto transactionsmanually from your cryptocurrency wallet./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/reverse HTTP/1.1Host: test.blockchyp.comContent-Length: 208Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:c115b3395a06c699330b99f7b96c3138f26ea12449824c534948ea5821372829Nonce: d4171288bdbdd24ae1db8873966cfdaed5bec6abfd2410a1d67543fcff159977Timestamp: 2021-05-19T21:38:42Z{ transactionRef: 1b0a9bbd92a, test: true, timeout: 120}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: approved, approved: true, authCode: 458923, transactionId: UM4CJ3VYVMI6XJY6AJBKYEIAAI, batchId: NK4XCAVYVMI6XFBOAJBKYEIAAU, transactionRef: 1b0a9bbd92a, transactionType: reverse, timestamp: 2021-05-19T21:38:43Z, tickBlock: 00079cc170c50477411b5565a1b0a9bbd92a51d838d7b6a36de107fbd8e986ac, test: true, partialAuth: false, altCurrency: false, fsaAuth: false, currencyCode: USD, requestedAmount: , authorizedAmount: 0.00, remainingBalance: , tipAmount: 0.00, taxAmount: 0.00, requestedCashBackAmount: , authorizedCashBackAmount: , entryMethod: CHIP, paymentType: AMEX, maskedPan: ***********1006, avsResponse: , receiptSuggestions: { merchantName: CLI Regression Test, requestSignature: false, maskedPan: ***********1006, authorizedAmount: 0.00, transactionType: reverse, entryMethod: CHIP, surcharge: 0.00, cashDiscount: 0.00 }}/div>h3 idgift-card-activation-api-gift-activate>Gift Card Activation ( /api/gift-activate )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/gift-activate/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API activates or adds value to BlockChyp gift cards.Just pass in the terminal name and the amount to add to the card.Once the customer swipes their card, the terminal will use keyson the mag stripe to add value to the card./p>p>You don't need to handle a new gift card activation or a gift card recharge anydifferently. The terminal firmware will figure out what to do on itsown while also returning the new balance for the gift card./p>p>This is the part of the system where BlockChyp's blockchain DNA comesclosest to the surface. The BlockChyp gift card system doesn't reallyuse gift card numbers. This means they can't be stolen./p>p>BlockChyp identifies cards with an elliptic curve public key instead.Gift card transactions are actually blocks signed with those keys.This means there are no shared secrets sent over the network.To keep track of a BlockChyp gift card, hang on to the strong>public key/strong> returnedduring gift card activation. That's the gift card's elliptic curve public key./p>p>We sometimes print numbers on our gift cards, but these are actuallydecimal encoded hashes of a portion of the public key to make our giftcards seem em>normal/em> to em>normies/em>. They can be usedfor balance checks and play a lookup role in online gift cardauthorization, but are of little use beyond that./p>p>strong>Voids and Reversals/strong>/p>p>Gift card activations can be voided and reversed just like any otherBlockChyp transaction. Use the Transaction ID or Transaction Refto identify the gift activation transaction as you normally would forvoiding or reversing a conventional payment transaction./p>p>strong>Importing Gift Cards/strong>/p>p>BlockChyp does have the ability to import gift card liability fromconventional gift card platforms. Unfortunately, BlockChyp does notsupport activating cards on third party systems. However, you can importyour outstanding gift cards and customers can swipe them on theterminals like BlockChyp's standard gift cards./p>p>No special coding is required to access this feature. The gateway andterminal firmware handle everything for you./p>p>strong>Third Party Gift Card Networks/strong>/p>p>BlockChyp does not currently provide any native support for other gift cardplatforms beyond importing gift card liability. We do have a white listing systemthat can be used to support your own custom gift card implementations. We have a security reviewprocess before we can allow a BIN range to be white listed, so contactsupport@blockchyp.com if you need to white list a BIN range./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/gift-activate HTTP/1.1Host: test.blockchyp.comContent-Length: 178Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:e45831f216622f33e66c51cfe5da3ab5fad9839eff9a257951752c0b46778676Nonce: 8b491b31ef7270395fbd5d57ea337b406aa924f4ccab24304caefe35554b0163Timestamp: 2021-05-20T17:27:14Z{ test: true, timeout: 120, amount: 50.00, terminalName: Test Terminal}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: APPROVED, transactionId: UM4CKGNYVMI6XJY6AJBKYEIAAI, transactionType: gift_activate, timestamp: 2021-05-20T17:27:18Z, tickBlock: 00070927532746c192dbfdb88b17613eec5514e81e2a3119f3936d5886edf344, test: true, approved: true, amount: 50.00, currentBalance: 150.00, currencyCode: USD, publicKey: 11kek9vHKFCRWrgjn4PJYPxaXQSjQma95v4f5Cfw9wi2zB1Ad9m, maskedPan: ************7089}/div>h3 idbalance-api-balance>Balance ( /api/balance )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/balance/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API checks a gift or EBT card balance./p>p>strong>Gift Card Balance Checks/strong>/p>p>For gift cards, pass in a terminal name and the customer will be promptedto swipe a card on that terminal. The remaining balance will be displayedbriefly on the terminal screen and the API response will include the gift card's public key and the remaining balance./p>p>strong>EBT Balance Checks/strong>/p>p>All EBT transactions require a PIN, so to check an EBT card balance,you need to pass in the code>ebt/code> flag just like you would for a normal EBTcharge transaction. The customer will be prompted to swipe their card andenter a PIN code. If everything checks out, the remaining balance on the card will be displayed on the terminal for the customer and returned with the API response./p>p>strong>Testing Gift Card Balance Checks/strong>/p>p>Test gift card balance checks work no differently than live gift cards. Youmust activate a test gift card first to test balance checks. Testgift cards are real blockchain cards that live on our parallel test blockchain./p>p>strong>Testing EBT Gift Card Balance Checks/strong>/p>p>All test EBT transactions assume a starting balance of $100.00. As a result,test EBT balance checks always return a balance of $100.00./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/balance HTTP/1.1Host: test.blockchyp.comContent-Length: 86Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:c189e92e524358ae4989a60d4c7ddf0d718356b03d186cea608be634ecfd88bdNonce: 6f7090600cf0b48c4b2ca65859047ef861971d3063d7141c7cd469cda44d3befTimestamp: 2021-05-20T17:37:07Z{ test: true, timeout: 120, terminalName: Test Terminal }Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: , transactionId: UM4CJ4FYVMI6XJY6AJBKYEIAAI, transactionType: balance, timestamp: , tickBlock: 00070927532746c192dbfdb88b17613eec5514e81e2a3119f3936d5886edf344, test: true, maskedPan: ************7089, publicKey: 11kek9vHKFCRWrgjn4PJYPxaXQSjQma95v4f5Cfw9wi2zB1Ad9m, avsResponse: , receiptSuggestions: { merchantName: CLI Regression Test, requestSignature: false, maskedPan: ************7089, authorizedAmount: , transactionType: balance, entryMethod: SWIPE }, remainingBalance: 150.00}/div>h3 idclose-batch-api-close-batch>Close Batch ( /api/close-batch )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/close-batch/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API will close the merchant's batch if it's currently open./p>p>By default, merchant batches will close automatically at 3 AM in theirlocal time zone. The automatic batch closure time can be changedin the Merchant Profile or disabled completely./p>p>If automatic batch closure is disabled, you'll need to use this API toclose the batch manually./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/close-batch HTTP/1.1Host: test.blockchyp.comContent-Length: 68Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:737031d47a94cfba8fd431c2c17dd01f18ed34f116f22bc000dc37222e038953Nonce: 345e9d66563f00dc87cd8776ae3c2e3f1ae29210b48858a1417dae4c71716e63Timestamp: 2021-05-19T21:58:39Z{ test: true, timeout: 120}Response:HTTP/1.1 200 OK{ success: true, test: true, batches: { batchId: NK4XCAVYVMI6XFBOAJBKYEIAAU, capturedAmount: 77.00, openPreauths: 0.00, currencyCode: USD, open: false, openDate: 0001-01-01T00:00:00Z, closeDate: 0001-01-01T00:00:00Z } }/div>h3 idsend-payment-link-api-send-payment-link>Send Payment Link ( /api/send-payment-link )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/send-payment-link/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API allows you to send an invoice to a customer and capture paymentvia a BlockChyp hosted payment page./p>p>If you set the code>autoSend/code> flag, BlockChyp will send a basic invoice emailto the customer for you that includes the payment link. If you'd rather havemore control over the look of the email message, you can omit the code>autoSend/code>flag and send the customer email yourself./p>p>There are a lot of optional parameters for this API, but at a minimumyou'll need to pass in a total, customer name, and email address. (Unlessyou use the code>cashier/code> flag.)/p>p>strong>Customer Info/strong>/p>p>Unless you're using the code>cashier/code> flag, you must specify a customer; either bycreating a new customer record inline or passing in an existing Customer ID or Customer Ref./p>p>strong>Line Item Level Data/strong>/p>p>It's not strictly required, but we strongly recommend sending line item leveldetail with every request. It will make the invoice look more completeand the data format for line item level data is the exact same format usedfor terminal line item display, so the same code can be used to support both areas./p>p>strong>Descriptions/strong>/p>p>You can also provide a free form description or message to display nearthe bottom of the invoice. Usually this is some kind of thank you noteor instruction./p>p>strong>Terms and Conditions/strong>/p>p>You can include long form contract language with a request and captureterms and conditions accepted at the same time payment is captured./p>p>The interface is identical to that used for the terminal based Terms andConditions API in that you can pass in content directly via code>tcContent/code> or viaa preconfigured template via code>tcAlias/code>. The Terms and Conditions log will also be updated whenagreement acceptance is incorporated into a send link request./p>p>strong>Auto Send/strong>/p>p>BlockChyp does not send the email notification automatically. This safeguard prevents real emails from going out when you may not expect them If you want BlockChyp to send the email for you, just add the code>autoSend/code> flag with all requests./p>p>strong>Cryptocurrency/strong>/p>p>If the merchant is configured to support cryptocurrency transactions, the payment page willdisplay additional UI widgets that allowing customers to switch to a crypto payment method./p>p>strong>Tokenization/strong>/p>p>Add the code>enroll/code> flag to a send link request to enroll the payment methodin the token vault./p>p>Add the code>enrollOnly/code> flag to enroll the payment method in the token vault without any immediate payment taking place. The payment link will ask the user for their payment information and inform them that they will not be charged immediately, but that their payment may be used for future transactions./p>p>strong>Cashier Facing Card Entry/strong>/p>p>BlockChyp can be used to generate internal/cashier facing card entry pages as well. This isdesigned for situations where you might need to take a phone order and don'thave an available terminal./p>p>If you pass in the code>cashier/code> flag, no email will be sent and you'll be able toload the link in a browser or iframe for payment entry. When the code>cashier/code> flagis used, the code>autoSend/code> flag will be ignored./p>p>Note that cryptocurrency is not supported for cashier facing payment entry./p>p>strong>Payment Notifications/strong>/p>p>When a customer successfully submits payment, the merchant will receive an emailnotifying them that the payment was received./p>p>strong>Real Time Callback Notifications/strong>/p>p>Email notifications are fine, but you may want your system to be informedimmediately whenever a payment event occurs. By using the optional code>callbackUrl/code> requestproperty, you can specify a URL to which the Authorization Response will be postedevery time the user submits a payment, whether approved or otherwise./p>p>The response will be sent as a JSON encoded POST request and will be the exactsame format as all BlockChyp charge and preauth transaction responses./p>p>strong>Status Polling/strong>/p>p>If real time callbacks aren't practical or necessary in your environment, you canalways use the Payment Link Status API described futher on./p>p>A common use case for the send link API with status polling is curbside pickup.You could have your system check the Payment Link Status when a customer arrives toensure it's been paid without necessarily needing to create background threadsto constantly poll for status updates./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/send-payment-link HTTP/1.1Host: api.blockchyp.comContent-Length: 836Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:a4b9a30dbe63a0e863baa3d64d46d1128af9b8e8a02ce31a60b97493a991ee55Nonce: fb773dbc4bba70a7b042c1afb054a5275fb4800e06f873dcce966bfc8f9e54a2Timestamp: 2021-05-19T22:04:16Z{ transactionRef: 12334, async: false, queue: false, orderRef: 12345, test: false, timeout: 120, currencyCode: , amount: 125.05, taxExempt: false, surcharge: false, cashDiscount: false, autoSend: true, cashier: false, description: Thank you for your order. Your order will be ready in 20 minutes, subject: , transaction: { subtotal: 120.05, tax: 5.00, total: 125.05, items: { id: , description: Leki Trekking Poles, price: 135.05, quantity: 1, extended: 120.05, unitCode: , commodityCode: , productCode: , discounts: { description: Member Discount, amount: 10.00 } } }, customer: { firstName: Erlich, lastName: Bachman, companyName: , emailAddress: support@blockchyp.com, smsNumber: , paymentMethods: null }}Response:HTTP/1.1 200 OK{ success: true, test: true, batches: { batchId: NK4XCAVYVMI6XFBOAJBKYEIAAU, capturedAmount: 77.00, openPreauths: 0.00, currencyCode: USD, open: false, openDate: 0001-01-01T00:00:00Z, closeDate: 0001-01-01T00:00:00Z } }/div>h3 idresend-payment-link-api-resend-payment-link>Resend Payment Link ( /api/resend-payment-link )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/resend-payment-link/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API will resend a previously created payment link. An error is returned if the payment link is expired, has beencancelled, or has already been paid./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/resend-payment-link HTTP/1.1Host: test.blockchyp.comContent-Length: 68Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:a8da5aa7ba6518b2ec392b3f7a221c5357b00163e0845bfbd769d161aa3c1effNonce: 3f915730b23a513342f667a4725e67fa373666e9341afec47e3c7fcb7ab5224dTimestamp: 2021-05-20T17:56:00Z{ test: true, linkCode: KJ3DPFELBAI6VOTRNSLM7WZLHE,}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: ,}/div>h3 idcancel-payment-link-api-cancel-payment-link>Cancel Payment Link ( /api/cancel-payment-link )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/cancel-payment-link/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API cancels a payment link./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/cancel-payment-link HTTP/1.1Host: test.blockchyp.comContent-Length: 68Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:a8da5aa7ba6518b2ec392b3f7a221c5357b00163e0845bfbd769d161aa3c1effNonce: 3f915730b23a513342f667a4725e67fa373666e9341afec47e3c7fcb7ab5224dTimestamp: 2021-05-20T17:56:00Z{ test: true, linkCode: KJ3DPFELBAI6VOTRNSLM7WZLHE,}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: ,}/div>h3 idpayment-link-status-api-payment-link-status>Payment Link Status ( /api/payment-link-status )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/payment-link-status/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API allows you to check on the status of a payment link, including transaction dataand the full history of attempted transactions./p>p>This API is the preferred source of truth and best practice when you want to check on the status of a payment link (as opposed to Transaction Status). The Transaction Status API is not ideal because of ambiguity when there are multiple transactions associated with a single payment link./p>p>You must pass the code>linkCode/code> value associated with the payment link. It is included in the response from BlockChyp when the payment link is originally created./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/payment-link-status HTTP/1.1Nonce: 64P8MVKP2YNE4DNJRDA3YAW9H7547RAXJWAZX6TA659H67R0PJP0Timestamp: 2023-08-16T17:01:24ZAuthorization: Dual 46KH4P7II3XTEZM6LKCWMBIJME:YKQNC256Q5A7GX7QH7GGSHLMGE:290858f5a9c063d7338158893711ac72af416ded08dd903ec0e4506e031f4de3Content-Length: 41host: api.dev.blockchyp.com{ linkCode: L52BKYSXARFNUXH4H2CKGX252A}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: , linkCode: L52BKYSXARFNUXH4H2CKGX252A, merchantId: 3IKWRKY47YI65L7VAJBKYEIAAQ, customerId: FDDUCZRXAMI65IUJAJBKYEIAAU, transactionRef: tx12345, amount: 199.99, subject: Widget invoice, description: Widget, expiration: 2023-10-15T17:00:53Z, dateCreated: 2023-08-16T17:00:53Z, transactionDetails: { subtotal: 195.00, tax: 4.99, total: 199.99, items: ... }, status: Pending}/div>h3 idtransaction-status-api-tx-status>Transaction Status ( /api/tx-status )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/tx-status/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API returns the current status for any transaction. You can lookup a transactionby its BlockChyp assigned Transaction ID or your own Transaction Ref./p>p>You should always use globally unique Transaction Ref values, but in the eventthat you duplicate Transaction Refs, the most recent transaction matching yourTransaction Ref is returned./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/tx-status HTTP/1.1Host: test.blockchyp.comContent-Length: 98Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:88955f94d702bba600d71a3b23f9c3cb0775e7384a7f50887d75f3dfeb6a0d34Nonce: 2fb49d2590bef282987c3e033140e6c3fb4a65c5ec6411f4b8283795f001c8adTimestamp: 2021-05-19T22:10:40Z{ test: true, transactionId: UM4CJ6NYVMI6XJY6AJBKYEIAAI}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: , approved: true, authCode: 469455, transactionId: UM4CJ6NYVMI6XJY6AJBKYEIAAI, batchId: UM4CJ5NYVMI6XJY6AJBKYEIAAI, transactionType: charge, timestamp: 2021-05-19T22:10:22Z, tickBlock: 0007fa1110db90ebd13ccf88e50b7077659b318620587ba94cbd29b31c9acf4d, test: true, partialAuth: false, altCurrency: false, fsaAuth: false, currencyCode: USD, requestedAmount: 41.00, authorizedAmount: 41.00, remainingBalance: , tipAmount: 0.00, taxAmount: 0.00, requestedCashBackAmount: 0.00, authorizedCashBackAmount: , entryMethod: CONTACTLESS EMV, paymentType: AMEX, maskedPan: ***********1006, cardHolder: UAT USA/Test Card 12, expMonth: 12, expYear: 24, avsResponse: , receiptSuggestions: { aid: A000000025010402, arqc: AFD3220422F217F6, iad: 06020103A02800, tvr: 8000008000, tsi: 6800, terminalId: IOYIIMFYDEI6XMG3AJBKYEIAAQ, merchantName: CLI Regression Test, merchantId: 4QZ2I4QYIMI6TPHVAJBKYEIAA4, applicationLabel: AMERICAN EXPRESS, requestSignature: false, maskedPan: ***********1006, authorizedAmount: 41.00, transactionType: charge, entryMethod: CONTACTLESS EMV }, customer: null, whiteListedCard: null, storeAndForward: false}/div>h3 idterminal-clear-api-terminal-clear>Terminal Clear ( /api/terminal-clear )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/terminal-clear/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API interrupts whatever a terminal may be doing and returns it to theidle state./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/terminal-clear HTTP/1.1Host: test.blockchyp.comContent-Length: 86Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:14db4e7bf0513cfe90835f6c8e616279a2d683296f9a118a368c0c3d5a694cddNonce: 419033f763749cb13f675a79d10845c6617b58ea52e1fd54aa9362dc40465058Timestamp: 2021-05-20T17:39:22Z{ test: true, timeout: 120, terminalName: Test Terminal}Response:HTTP/1.1 200 OK{ success:true, errorMessage:}/div>h3 idterminal-status-api-terminal-status>Terminal Status ( /api/terminal-status )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/terminal-status/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API returns the current status of a payment terminal. This is typically usedas a way to determine if the terminal is busy before sending a new transaction./p>p>If the terminal is busy, code>idle/code> will be false and the code>status/code> field will returna short string that indicates the transaction type currently in progress. The systemwill also return the timestamp of the last status change in the code>since/code> field./p>p>The code>cardInSlot/code> field in the response will indicates whether or not a card is currently in the card reader slot./p>p>If the system is running a payment transaction and you wisely passed in aTransaction Ref, this API will also return the Transaction Ref of the in progresstransaction./p>p>The table below lists all possible status responses./p>table>thead>tr>th>Status Code/th>th>Description/th>/tr>/thead>tbody>tr>td>idle/td>td>The terminal is idle and ready for transactions. The default branding is being displayed./td>/tr>tr>td>activate/td>td>The terminal is in the process of activating and pairing with the merchant account./td>/tr>tr>td>balance/td>td>A balance check (EBT or Gift Card) is pending on the terminal./td>/tr>tr>td>boolean-prompt/td>td>A boolean prompt (yes/no) operation is pending on the terminal./td>/tr>tr>td>signature/td>td>A signature capture is pending./td>/tr>tr>td>crypto/td>td>A cryptocurrency transaction is pending./td>/tr>tr>td>enroll/td>td>A token vault enrollment operation is pending./td>/tr>tr>td>gift-activate/td>td>A gift card activation operation is in progress./td>/tr>tr>td>message/td>td>The terminal is displaying a custom message./td>/tr>tr>td>charge/td>td>The terminal is executing a charge transaction./td>/tr>tr>td>preauth/td>td>The terminal is executing a preauth transaction./td>/tr>tr>td>refund/td>td>The terminal is executing a refund transaction./td>/tr>tr>td>survey/td>td>The terminal is displaying post transaction survey questions./td>/tr>tr>td>terms-and-conditions/td>td>The terminal is pending terms and conditions acceptance and signature./td>/tr>tr>td>text-prompt/td>td>The terminal is awaiting response to a text input prompt./td>/tr>tr>td>txdisplay/td>td>The terminal is displaying transaction and/or line item level details./td>/tr>/tbody>/table>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/terminal-status HTTP/1.1Host: test.blockchyp.comContent-Length: 86Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:3dcc2377a7b162a602606931b89ac2ff8cb0f2d1ae9c9198c27329f91b20e92fNonce: 95d20bdad169878a5c952905c6e1ac237681dfce67a0f781e223490b6ae37f5bTimestamp: 2021-05-20T17:40:24Z{ test: true, timeout: 120, terminalName: Test Terminal}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: , idle: true, status: idle, since: 2021-05-20T17:37:11.49586231Z}/div>h3 idterms-amp-conditions-capture-api-terminal-tc>Terms & Conditions Capture ( /api/terminal-tc )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/terminal-tc/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Terms & Conditions Management/li>/ul>p>This API allows you to prompt a customer to accept a legal agreement on the terminaland (usually) capture their signature./p>p>Content for the agreement can be specified in two ways. You can reference apreviously configured T&C template or pass in the full agreement text with every request./p>p>strong>Using Templates/strong>/p>p>If your application doesn't keep track of agreements you can leverage BlockChyp'stemplate system. You can create any number of T&C Templates in the merchant dashboardand pass in the code>tcAlias/code> flag to specify which one should display./p>p>strong>Raw Content/strong>/p>p>If your system keeps track of the agreement language or executes complicated mergingand rendering logic, you can bypass our template system and pass in the full text withevery transaction. Use code>tcName/code> to pass in the agreement name and code>tcContent/code> topass in the contract text. Note that only plain text is supported./p>p>strong>Bypassing Signatures/strong>/p>p>Signature images are captured by default. If for some reason this doesn't fit youruse case and you'd like to capture acceptance without actually capturing a signature image, setthe code>disableSignature/code> flag in the request./p>p>strong>Terms & Conditions Log/strong>/p>p>Every time a user accepts an agreement on the terminal, the signature image (if captured),will be uploaded to the gateway. The image will also be added to the log along with the full text of theagreement. This preserves the historical record in the event that standard agreementsor templates change over time./p>p>strong>Associating Agreements with Transactions/strong>/p>p>To associate a Terms & Conditions log entry with a transaction, just pass in theTransaction ID or Transaction Ref for the associated transaction./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/terminal-tc HTTP/1.1Host: test.blockchyp.comContent-Length: 226Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:e399632589d19d2904482f403a6ba5a982fce9a64653e4df8ae4a64aac8e6f08Nonce: 37156809d66e7b9d61eef31154176c826c39e3c4a3353f94ffe47fb6abed2bceTimestamp: 2021-05-20T17:42:06Z{ test: true, timeout: 120, terminalName: Test Terminal, tcAlias: , tcName: HIPPA Disclosure, tcContent: Loreum Ipsum..., sigRequired: true}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: , test: true}/div>h3 idcapture-signature-api-capture-signature>Capture Signature ( /api/capture-signature )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/capture-signature/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This endpoint captures a written signature from the terminal and returns theimage./p>p>Unlike the Terms & Conditions API, this endpoint performs basic signaturecapture with no agreement display or signature archival./p>p>Under the hood, signatures are captured in a proprietary vector format andmust be converted to a common raster format in order to be useful to mostapplications. At a minimum, you must specify an image format using thecode>sigFormat/code> parameter. Currently, JPG and PNG are supported./p>p>By default, images are returned in the JSON response as hex encoded binary.You can redirect the binary image output to a file using the code>sigFile/code>parameter./p>p>You can also scale the output image to your preferred width bypassing in a code>sigWidth/code> parameter. The image will be scaled to thatwidth, preserving the aspect ratio of the original image./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/capture-signature HTTP/1.1Host: test.blockchyp.comUser-Agent: Go-http-client/1.1Content-Length: 119Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:50992c407d25197a0c1d6cfea8001e0456ac2cf6cbb996b6d13d8180f8db6473Nonce: aef53a380f4a544ecf1c17cc592a5de2b4107e87acdf1865e98b4d612b26f174Timestamp: 2021-05-20T17:43:58Z{ test: true, timeout: 120, sigFormat: png, sigWidth: 100, terminalName: Test Terminal}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: , sigFile: 89504e470d0a1a0a0000000d49484452000000640000001c080200000018f18daf0000024449444154789cec97cfab31511cc6cf3577ee8fba8d50caca5a2c95bf80599164a548c9626a7692a5b16235ab59d8d9b0b36665214d6463a159a258d8698c8490b7b7a99bd77b638e3973879acfea2c9ce73ce7e3f40dd3490f0e87c368342a97cbe1703893c9e0381e894400006f6f6f0080542a35180c7429761df06b27ad562b86610281806c44211cc7fd5ac39b682beb783cf23cfff5f50500787d7dbd1081e33800201e8f5b2c9642a1108d468bc5224992ff2bdbeff79af6548856b2fafdfe8f6a1c0e47b3d95c2e9737137abddef9768d7a4281be04c771e79774b95c2449b22cbb5eafef48a3284ace99cfe7c8abc2825256b55a3dd79448243a9d8efa58392d168ba1e8a88acb39723766b3599224794d5154a95422080249b2dbed1604c16ab52249530512e58d46434ef3f97c922421c9fc464e3699f4f995f34f13f511b3d9cc66b30100f2f93c8a4a97c8b23e3e3eb408876ba23e82a6690040301844d1e70764599f9f9f1ae52b07c1cc4aa7d3044164b359f55157d86c369ae62b42ef6feb36c964f241aabe7cbff387653a9d3a9d4e00c07038f4783c3a367902597f5bbebcc88bdd6e07f5d7122d26bd0e8642100479f1fefede6ab5946fec76bbb95cceeff7330c83a087de734029b55aedbc364dd3954a6532996cb7dbf38f89a2c8715c2814bab8268661a228aaecf034b24ea7d3783cf67abd773c08bbddde6eb7d517782659328bc5a25eaf5fb7836118cbb23ccfa33dfa3906fc83f01c03fe4130644160c882c0900581210b02431604862c080c591018b220f8130000ffff6856c01532c2544d0000000049454e44ae426082}/div>h3 idnew-transaction-display-api-terminal-txdisplay>New Transaction Display ( /api/terminal-txdisplay )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/terminal-txdisplay/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API sends totals and line item level data to the terminal./p>p>At a minimum, you should send total information as part of a display request,including code>total/code>, code>tax/code>, and code>subtotal/code>./p>p>You can also send line item level data and each line item can have a code>description/code>,code>qty/code>, code>price/code>, and code>extended/code> price./p>p>If you fail to send an extended price, BlockChyp will multiply the code>qty/code> by thecode>price/code>. However, we strongly recommend you precalculate all the fields yourselfto ensure consistency. For example, your treatment of floating-point multiplication and rounding may differ slightly from BlockChyp's./p>p>strong>Discounts/strong>/p>p>You have the option to show discounts on the display as individual line itemswith negative values or you can associate discounts with a specific line item.You can apply any number of discounts to an individual line item with a descriptionand amount./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/terminal-txdisplay HTTP/1.1Host: test.blockchyp.comContent-Length: 373Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:39977c86c0872468329557ae661aebfd534cd3e340c59b475f20a7ed1c036cd0Nonce: 41bf63c2608ba377c4c234a16cc39c655768694715e53a74067a1f0f80599081Timestamp: 2021-05-20T17:46:11Z{ async: false, queue: false, test: true, timeout: 120, terminalName: Test Terminal, transaction: { subtotal: 120.05, tax: 5.00, total: 125.05, items: { id: , description: Leki Trekking Poles, price: 135.05, quantity: 1, extended: 120.05, unitCode: , commodityCode: , productCode: , discounts: { description: Member Discount, amount: 10.00 } } }}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: }/div>h3 idupdate-transaction-display-api-terminal-txdisplay>Update Transaction Display ( /api/terminal-txdisplay )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>PUT/td>td>/api/terminal-txdisplay/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>Similar to em>New Transaction Display/em>, this variant allows developers to updateline item level data currently being displayed on the terminal./p>p>This feature is designed for situations where you want to update the terminal display asitems are scanned. You'll only have to send information to theterminal that's changed, which usually means the new line item and updated totals./p>p>If the terminal is not in line item display mode and you invoke this endpoint,the first invocation will behave like a em>New Transaction Display/em> call./p>p>At a minimum, you should send total information as part of a display request,including code>total/code>, code>tax/code>, and code>subtotal/code>./p>p>You can also send line item level data and each line item can have a code>description/code>,code>qty/code>, code>price/code>, and code>extended/code> price./p>p>If you fail to send an extended price, BlockChyp will multiply the code>qty/code> by thecode>price/code>. However, we strongly recommend you precalculate all the fields yourselfto ensure consistency. For example, your treatment of floating-point multiplication and roundingmay differ slightly from BlockChyp's./p>p>strong>Discounts/strong>/p>p>You have the option to show discounts on the display as individual line itemswith negative values or you can associate discounts with a specific line item.You can apply any number of discounts to an individual line item with a descriptionand amount./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:PUT /api/terminal-txdisplay HTTP/1.1Host: test.blockchyp.comContent-Length: 373Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:39977c86c0872468329557ae661aebfd534cd3e340c59b475f20a7ed1c036cd0Nonce: 41bf63c2608ba377c4c234a16cc39c655768694715e53a74067a1f0f80599081Timestamp: 2021-05-20T17:46:11Z{ async: false, queue: false, test: true, timeout: 120, terminalName: Test Terminal, transaction: { subtotal: 120.05, tax: 5.00, total: 125.05, items: { id: , description: Leki Trekking Poles, price: 135.05, quantity: 1, extended: 120.05, unitCode: , commodityCode: , productCode: , discounts: { description: Member Discount, amount: 10.00 } } }}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: }/div>h3 iddisplay-message-api-message>Display Message ( /api/message )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/message/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API displays a message on the payment terminal./p>p>Just specify the target terminal and the message using the code>message/code> parameter./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/message HTTP/1.1Host: test.blockchyp.comContent-Length: 118Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:efadd49f191a1bb5237778281130a5837a3799fa112e72728548e18b9de72609Nonce: 808450078c4c4e0458ae761ddad3172fba52c26bf5a184f116d25c28bb6a49c7Timestamp: 2021-05-20T17:51:49Z{ test: true, timeout: 120, terminalName: Test Terminal, message: Payments is broken.}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: }/div>h3 idboolean-prompt-api-boolean-prompt>Boolean Prompt ( /api/boolean-prompt )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/boolean-prompt/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API prompts the customer to answer a yes or no question./p>p>You can specify the question or prompt with the code>prompt/code> parameter andthe response is returned in the code>response/code> field./p>p>This can be used for a number of use cases including starting a loyalty enrollmentworkflow or customer facing suggestive selling prompts./p>p>strong>Custom Captions/strong>/p>p>You can optionally override the "YES" and "NO" button captions byusing the code>yesCaption/code> and code>noCaption/code> request parameters./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/boolean-prompt HTTP/1.1Host: test.blockchyp.comContent-Length: 211Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:babc594d057a4daa60f4917ee2c0a0bbe47e9bfded69a4f0cda2c92839b3b79dNonce: b77b042d15c4742b0195d71db7d195e7cae5035291a579ea36e378c784629bfbTimestamp: 2021-05-20T17:54:06Z{ test: true, timeout: 120, terminalName: Test Terminal, yesCaption: Yes, noCaption: No, prompt: Shouldnt we decentralize payment networks with a blockchain nobody controls?}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: , response: true}/div>h3 idtext-prompt-api-text-prompt>Text Prompt ( /api/text-prompt )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/text-prompt/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API prompts the customer to enter numeric or alphanumeric data./p>p>Due to PCI rules, free-form prompts are not permitted when the responsecould be any valid string. The reason for this is that a maliciousdeveloper (not you, of course) could use text prompts to ask the customer toinput a card number or PIN code./p>p>This means that instead of providing a prompt, you provide a code>promptType/code> instead./p>p>The prompt types currently supported are listed below:/p>ul>li>strong>phone/strong>: Captures a phone number./li>li>strong>email/strong>: Captures an email address./li>li>strong>first-name/strong>: Captures a first name./li>li>strong>last-name/strong>: Captures a last name./li>li>strong>customer-number/strong>: Captures a customer number./li>li>strong>rewards-number/strong>: Captures a rewards number./li>/ul>p>You can specify the prompt with the code>promptType/code> parameter andthe response is returned in the code>response/code> field./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/text-prompt HTTP/1.1Host: test.blockchyp.comContent-Length: 107Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:a8da5aa7ba6518b2ec392b3f7a221c5357b00163e0845bfbd769d161aa3c1effNonce: 3f915730b23a513342f667a4725e67fa373666e9341afec47e3c7fcb7ab5224dTimestamp: 2021-05-20T17:56:00Z{ test: true, timeout: 120, terminalName: Test Terminal, promptType: email}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: , response: peter@raviga.capital }/div>h3 idupdate-customer-api-update-customer>Update Customer ( /api/update-customer )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/update-customer/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API adds or updates a customer record./p>p>If you pass in customer information including code>firstName/code>, code>lastName/code>, code>email/code>,or code>sms/code> without any Customer ID or Customer Ref, a new record willbe created./p>p>If you pass in code>customerRef/code> and code>customerId/code>, the customer record will be updatedif it exists./p>p>strong>Customer Ref/strong>/p>p>The code>customerRef/code> field is optional, but highly recommended as this allows youto use your own customer identifiers instead of storing BlockChyp's Customer IDsin your systems./p>p>strong>Creating Customer Records With Payment Transactions/strong>/p>p>If you have customer information available at the time a payment transaction isexecuted, you can pass all the same customer information directly into a payment transaction. BlockChypwill create a customer record at the same time payment is captured. The advantage of this approach isthat the customer's payment card is automatically associated with the customer record in a single step.If the customer uses the payment card in the future, the customer data will automaticallybe returned. You won't need to ask the customer to provide any additional information./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/update-customer HTTP/1.1Host: test.blockchyp.comContent-Length: 251Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:bed1e544d93d61a9e0a235887461efd7a03ecc1e01c1607495e678af17562783Nonce: d91b0c935c968c9e55b19cb0b42e72eb9721a4a438b7b1e8714b66338eddb168Timestamp: 2021-05-20T13:12:55Z{ test: true, timeout: 120, customer: { id: , customerRef: , firstName: Peter, lastName: Gregory, companyName: Raviga Capital, emailAddress: peter@raviga.capital, smsNumber: 9136488888 }}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: , customer: { id: VAF2GL5Y7UI6XN4CAJBKYEIAAM, customerRef: , firstName: Peter, lastName: Gregory, companyName: Raviga Capital, emailAddress: peter@raviga.capital, smsNumber: 9136488888, paymentMethods: null }}/div>h3 idretrieve-customer-api-customer>Retrieve Customer ( /api/customer )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/customer/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>With this API, you can retrieve detailed information about a customer record, including saved paymentmethods if available./p>p>Customers can be looked up by code>customerId/code> or code>customerRef/code>./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/customer HTTP/1.1Host: test.blockchyp.comContent-Length: 115Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:104664249b008d13f28029da15dd50aa9cb133f93f8b149db97cb5a1fdd4a4a6Nonce: 2c669cfc4af0cbe75ac002c7a846008b6de2e5a63d4ab63ce175a5e820e66ecaTimestamp: 2021-05-20T13:15:49Z{ test: true, timeout: 120, customerId: VAF2GL5Y7UI6XN4CAJBKYEIAAM, customerRef: }Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: , customer: { id: VAF2GL5Y7UI6XN4CAJBKYEIAAM, customerRef: , firstName: Peter, lastName: Gregory, companyName: Raviga Capital, emailAddress: peter@raviga.capital, smsNumber: 9136488888, paymentMethods: }}/div>h3 idsearch-customer-api-customer-search>Search Customer ( /api/customer-search )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/customer-search/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API searches the customer database and returns matching results./p>p>Use code>query/code> to pass in a search string and the system will return all results whosefirst or last names contain the query string./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/customer-search HTTP/1.1Host: test.blockchyp.comUser-Agent: Go-http-client/1.1Content-Length: 73Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:4edab10aee61bcc22fcbe889a0c47bfdcd0d5ea38451590ad3895a9cfc8b3756Nonce: 118e5f3263e3622438084e39f9d90210d97afa32ef3c5b2d34c23680b3ff238eTimestamp: 2021-05-20T13:21:43Z{ test: true, timeout: 120, query: Erlich}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: , customers: { id: 5CNL3Z5Y7UI6XN4CAJBKYEIAAM, customerRef: , firstName: Erlich, lastName: Bachman, companyName: Aviato, emailAddress: erlich@aviato.io, smsNumber: 9136488888, paymentMethods: null }, { id: YAVEKWVY5AI6XN4CAJBKYEIAAM, customerRef: , firstName: Erlich, lastName: Bachman, companyName: , emailAddress: support@blockchyp.com, smsNumber: , paymentMethods: null } }/div>h3 idcash-discount-api-cash-discount>Cash Discount ( /api/cash-discount )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/cash-discount/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API calculates the surcharge, cash discount, and total amounts for cash transactions./p>p>If you're using BlockChyp's cash discounting features, you can use this endpointto ensure the numbers and receipts for true cash transactions are consistentwith transactions processed by BlockChyp./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/cash-discount HTTP/1.1Host: test.blockchyp.comContent-Length: 149Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:34d173c7d474ed2f246bb1c9afef75ecb74af5c43f815a403fbfc51d2a010a8aNonce: 98e229cabfa9d9a27296bdfb03b797b571307acf0f4f49943e2566f2f4d2c281Timestamp: 2021-05-20T13:24:33Z{ test: true, timeout: 120, currencyCode: USD, amount: 100.00, taxExempt: false, surcharge: true, cashDiscount: true}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: , currencyCode: , amount: 100.00, taxExempt: false, surcharge: 3.51, cashDiscount: 3.51}/div>h3 idbatch-history-api-batch-history>Batch History ( /api/batch-history )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/batch-history/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This endpoint allows developers to query the gateway for the merchant's batch history.The data will be returned in descending order of open date with the most recentbatch returned first. The results will include basic information about the batch.Consider using the Batch Details API for more detail about a specific batch./p>p>strong>Limiting Results/strong>/p>p>This API will return a maximum of 250 results. Use the code>maxResults/code> property tolimit maximum results even further and use the code>startIndex/code> property topage through results that span multiple queries./p>p>For example, if you want the ten most recent batches, pass in a value ofcode>10/code> for code>maxResults/code>. Also note that code>startIndex/code> is zero based. Use a value of code>0/code> toget the first batch in the dataset./p>p>strong>Filtering by Date Range/strong>/p>p>You can also filter results by date. Use the code>startDate/code> and code>endDate/code>properties to return only those batches opened between those dates.You can use either code>startDate/code> and code>endDate/code> and you can use date filtersin conjunction with code>maxResults/code> and code>startIndex/code>/p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/batch-history HTTP/1.1Host: test.blockchyp.comContent-Length: 151Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:8ebe164dc594f0d755b5b1bdda3bb43be14d474f07fdd41d598ccf22d13e2268Nonce: cea628e7eabfad25c21811fb5f7effb77b8d71d2509fd8d0f6f2347a9d531962Timestamp: 2021-05-20T13:27:01Z{ test: true, timeout: 0, maxResults: 5, startIndex: 1}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: , test: true, batches: { batchId: NK4XCAVYVMI6XFBOAJBKYEIAAU, entryMethod: , destinationAccountId: , capturedAmount: 77.00, openPreauths: , currencyCode: , open: false, openDate: 2021-05-19T20:51:46Z, closeDate: 2021-05-19T21:58:40Z }, { batchId: LE754DI22UI6XPADAJBKYEIAAI, entryMethod: , destinationAccountId: , capturedAmount: 135.34, openPreauths: , currencyCode: , open: false, openDate: 2020-11-11T00:13:34Z, closeDate: 2020-11-11T12:00:05Z }, { batchId: LE75VBI22UI6XPADAJBKYEIAAI, entryMethod: , destinationAccountId: , capturedAmount: 236.90, openPreauths: , currencyCode: , open: false, openDate: 2020-11-02T23:55:43Z, closeDate: 2020-11-03T12:00:05Z }, { batchId: 5B27QVYN3UI6XD4FAJBKYEIAAM, entryMethod: , destinationAccountId: , capturedAmount: 55.55, openPreauths: , currencyCode: , open: false, openDate: 2020-10-16T19:35:31Z, closeDate: 2020-10-17T11:00:05Z }, { batchId: RKXQUNXBD4I6VPCWAJBKYEIAAQ, entryMethod: , destinationAccountId: , capturedAmount: 294.00, openPreauths: , currencyCode: , open: false, openDate: 2020-08-18T17:17:12Z, closeDate: 2020-08-19T11:00:05Z } , maxResults: 5, startIndex: 1, totalResultCount: 55}/div>h3 idbatch-details-api-batch-details>Batch Details ( /api/batch-details )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/batch-details/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API allows developers to pull down details for a specific batch,including captured volume, gift card activity, expected deposit, andcaptured volume broken down by terminal./p>p>The only required request parameter is code>batchId/code>. Batch IDs are returnedwith every transaction response and can be discovered using the BatchHistory API./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/batch-details HTTP/1.1Host: test.blockchyp.comContent-Length: 92Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:62420ea32aa49977bb5c5e14fed07adeb3381778be204358c0acedaffa45cfdfNonce: e644c3052676a1201757a5856e1b38e4ac7a3e03cc5d31d14ccbe827cd2e4ca9Timestamp: 2021-05-20T13:30:00Z{ test: true, timeout: 120, batchId: NK4XCAVYVMI6XFBOAJBKYEIAAU}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: , test: true, batchId: NK4XCAVYVMI6XFBOAJBKYEIAAU, entryMethod: , destinationAccountId: , capturedAmount: 77.00, openPreauths: 0.00, totalVolume: 77.00, transactionCount: 8, giftCardsSold: 100.00, giftCardVolume: 0.00, expectedDeposit: 77.00, open: false, openDate: 2021-05-19T20:51:46Z, closeDate: 2021-05-19T21:58:40Z, volumeByTerminal: }/div>h3 idtransaction-history-api-tx-history>Transaction History ( /api/tx-history )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/tx-history/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This endpoint provides several different methods to sift throughtransaction history./p>p>By default with no filtering properties, this endpoint will return the 250most recent transactions./p>p>strong>Limiting Results/strong>/p>p>This API will return a maximum of 50 results in a single query. Use the code>maxResults/code> propertyto limit maximum results even further and use the code>startIndex/code> property topage through results that span multiple queries./p>p>For example, if you want the ten most recent batches, pass in a value ofcode>10/code> for code>maxResults/code>. Also note that code>startIndex/code> is zero based. Use a value of code>0/code> toget the first transaction in the dataset./p>p>strong>Filtering By Date Range/strong>/p>p>You can also filter results by date. Use the code>startDate/code> and code>endDate/code>properties to return only transactions run between those dates.You can use either code>startDate/code> or code>endDate/code> and you can use date filtersin conjunction with code>maxResults/code> and code>startIndex/code>/p>p>strong>Filtering By Batch/strong>/p>p>To restrict results to a single batch, pass in the code>batchId/code> parameter./p>p>strong>Filtering By Terminal/strong>/p>p>To restrict results to those executed on a single terminal, pass in the terminal name./p>p>strong>Combining Filters/strong>/p>p>None of the above filters are mutually exclusive. You can combine any of theabove properties in a single request to restrict transaction results to anarrower set of results./p>p>strong>Searching Transaction History/strong>/p>p>You can search transaction history by passing in search criteria with the code>query/code> option. The search system will match the amount (requested and authorized),last four of the card number, cardholder name, and the auth code./p>p>Note that when search queries are used, terminalName or batch id filters are not supported./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/tx-history HTTP/1.1Host: test.blockchyp.comUser-Agent: Go-http-client/1.1Content-Length: 208Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:2e75c336b67115fe5b3a361d785bc59b622bcefa7f140456b468c345fe526683Nonce: efefafee5f0015a97aa5d5821f7b39246835f374e0ee95226a580a438df4be6fTimestamp: 2021-05-20T13:34:40Z{ test: true, timeout: 120, batchId: NK4XCAVYVMI6XFBOAJBKYEIAAU, terminalName: , startDate: 0001-01-01T00:00:00Z, endDate: 0001-01-01T00:00:00Z, maxResults: 2, startIndex: 0}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: , test: true, batchId: NK4XCAVYVMI6XFBOAJBKYEIAAU, terminalName: , startDate: 0001-01-01T00:00:00Z, endDate: 0001-01-01T00:00:00Z, maxResults: 2, startIndex: 0, totalResultCount: 14, transactions: { success: true, error: , responseDescription: , approved: true, transactionId: UM4CJ5FYVMI6XJY6AJBKYEIAAI, batchId: NK4XCAVYVMI6XFBOAJBKYEIAAU, transactionType: gift_activate, timestamp: 2021-05-19T21:45:00Z, tickBlock: , test: true, partialAuth: false, altCurrency: false, fsaAuth: false, currencyCode: USD, requestedAmount: 100.00, authorizedAmount: 100.00, remainingBalance: , tipAmount: 0.00, taxAmount: 0.00, requestedCashBackAmount: 0.00, authorizedCashBackAmount: , entryMethod: SWIPE, paymentType: BC_GIFT, maskedPan: ************7089, publicKey: 11kek9vHKFCRWrgjn4PJYPxaXQSjQma95v4f5Cfw9wi2zB1Ad9m, avsResponse: , receiptSuggestions: { terminalId: IOYIIMFYDEI6XMG3AJBKYEIAAQ, merchantName: CLI Regression Test, merchantId: 4QZ2I4QYIMI6TPHVAJBKYEIAA4, requestSignature: false, maskedPan: ************7089, authorizedAmount: 100.00, transactionType: gift_activate, entryMethod: SWIPE }, customer: null, whiteListedCard: null, storeAndForward: false }, { success: true, error: , responseDescription: , approved: true, authCode: 458923, transactionId: UM4CJ3VYVMI6XJY6AJBKYEIAAI, batchId: NK4XCAVYVMI6XFBOAJBKYEIAAU, transactionRef: 1b0a9bbd92a, transactionType: reverse, timestamp: 2021-05-19T21:38:43Z, tickBlock: 00079cc170c50477411b5565a1b0a9bbd92a51d838d7b6a36de107fbd8e986ac, test: true, partialAuth: false, altCurrency: false, fsaAuth: false, currencyCode: USD, requestedAmount: 0.00, authorizedAmount: 0.00, remainingBalance: , tipAmount: 0.00, taxAmount: 0.00, requestedCashBackAmount: 0.00, authorizedCashBackAmount: , entryMethod: CHIP, paymentType: AMEX, maskedPan: ***********1006, cardHolder: /, avsResponse: , receiptSuggestions: { merchantName: CLI Regression Test, merchantId: 4QZ2I4QYIMI6TPHVAJBKYEIAA4, requestSignature: false, maskedPan: ***********1006, authorizedAmount: 0.00, transactionType: reverse, entryMethod: CHIP }, customer: null, whiteListedCard: null, storeAndForward: false } }/div>h3 idretrieve-pricing-policy-api-read-pricing-policy>Retrieve Pricing Policy ( /api/read-pricing-policy )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/read-pricing-policy/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Partner/li>li>strong>Required Role:/strong> Partner API Access/li>/ul>p>The API returns the current pricing policy for a merchant. This API is valid for partner scoped API credentialsand code>merchantId/code> is a required parameter. By default this API returns the currently in-force pricing policy for a merchant,but other inactive policies can be returned by providing the code>id/code> parameter./p>p>Buy rates for interchange plus and fixed rate pricing are always returned, but only the pricing related to the pricing model type (flat rate or interchange plus) are actually used in fee calculation./p>p>Each pricing level returns three values: code>buyRate/code>, code>current/code>, and code>limit/code>. The actual price the merchant will pay is given in the code>current/code> field. The other values reflect the contract minimum (code>buyRate/code>) and maximum (code>limit/code>) rangethe partner can use when changing prices./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/pricing-policy HTTP/1.1Host: api.blockchyp.comContent-Length: 54Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:4725705ce63983c1acd0a929d4bdc06530d02c46eb7a5f2b6cadd8319b23b38dNonce: c3c7be79ecd5e41a0dbe2327213c9e742d562375975fc31a63df97ab936b60b5Timestamp: 2021-05-20T13:39:51Z{ test: false, timeout: 120, merchantId: W5JC7000VXAI6ZE6KAJBKYEIAAI}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: , id: W5JCGFVVXAI6ZE6K700KYEIAAI, partnerId: Y5F3U5NQMII6ZBSUA700YEIAAU, merchantId: W5JC7000VXAI6ZE6KAJBKYEIAAI, enabled: true, timestamp: 2022-04-06T17:17:29Z, description: Credit: 5 cents + 10 pts Debit:, policyType: interchange, partnerMarkupSplit: 25%, standardFlatRate: { buyRate: 0.015%, current: 0%, limit: 0% }, debitFlatRate: { buyRate: 0.015%, current: 0%, limit: 0% }, ecommerceFlatRate: { buyRate: 0.015%, current: 0%, limit: 0% }, keyedFlatRate: { buyRate: 0.015%, current: 0%, limit: 0% }, premiumFlatRate: { buyRate: 0.12%, current: 0%, limit: 0% }, standardInterchangeMarkup: { buyRate: 0.015%, current: 0.1%, limit: 0% }, debitInterchangeMarkup: { buyRate: 0.015%, current: 0.1%, limit: 0% }, ecommerceInterchangeMarkup: { buyRate: 0.02%, current: 0.1%, limit: 0% }, keyedInterchangeMarkup: { buyRate: 0.02%, current: 0.1%, limit: 0% }, premiumInterchangeMarkup: { buyRate: 0.12%, current: 0.2%, limit: 0% }, standardTransactionFee: { buyRate: 0.02, current: 0.05, limit: 0.00 }, debitTransactionFee: { buyRate: 0.02, current: 0.05, limit: 0.00 }, ecommerceTransactionFee: { buyRate: 0.02, current: 0.05, limit: 0.00 }, keyedTransactionFee: { buyRate: 0.02, current: 0.05, limit: 0.00 }, premiumTransactionFee: { buyRate: 0.07, current: 0.10, limit: 0.00 }, ebtTransactionFee: { buyRate: 0.065, current: 0.10, limit: 0.00 }, monthlyFee: { buyRate: 5.00, current: 10.00, limit: 0.00 }, annualFee: { buyRate: 0.00, current: 0.00, limit: 0.00 }, chargebackFee: { buyRate: 12.00, current: 20.00, limit: 0.00 }, avsFee: { buyRate: 0.00, current: 0.00, limit: 0.00 }, batchFee: { buyRate: 0.07, current: 0.08, limit: 0.00 }, voiceAuthFee: { buyRate: 0.75, current: 1.00, limit: 0.00 }, accountSetupFee: { buyRate: 0.00, current: 0.00, limit: 0.00 }}/div>h3 idpartner-statements-api-partner-statement-list>Partner Statements ( /api/partner-statement-list )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/partner-statement-list/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Partner/li>li>strong>Required Role:/strong> Partner API Access/li>/ul>p>The API returns a list of partner residual statements. By default, all statements are returned with the most recentstatements listed first. Optional date parameters (code>startDate/code> and code>endDate/code>) can filter statements to a specific date range./p>p>The list of statements returns basic information about statements like volume, transaction count, and commissions earned./p>p>Use the code>id/code> returned with each statement summary with the em>Partner Statement Detail/em> API to pull down full details./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/partner-statement-list HTTP/1.1Host: api.blockchyp.comContent-Length: 54Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:4725705ce63983c1acd0a929d4bdc06530d02c46eb7a5f2b6cadd8319b23b38dNonce: c3c7be79ecd5e41a0dbe2327213c9e742d562375975fc31a63df97ab936b60b5Timestamp: 2021-05-20T13:39:51Z{ test: false, timeout: 120}Response:HTTP/1.1 200 OK{success: true,error: ,responseDescription: ,statements: { id: SCH34K3JAEI65EJNAJBKYEIAAI, statementDate: 2023-10-23T20:14:06Z, totalVolume: 548483.05, totalVolumeFormatted: 548,483.05, transactionCount: 12175, partnerCommission: 395.15, partnerCommissionFormatted: 395.15, status: paid }, { id: 4ZIRR72NQQI65BU7AJBKYEIAAI, statementDate: 2023-09-08T16:20:57Z, totalVolume: 513166.46, totalVolumeFormatted: 513,166.46, transactionCount: 12341, partnerCommission: 386.99, partnerCommissionFormatted: 386.99, status: paid }, { id: 2BRDQHRS6MI65F7UAJBKYEIAAQ, statementDate: 2023-08-04T21:02:42Z, totalVolume: 680464.72, totalVolumeFormatted: 680,464.72, transactionCount: 17125, partnerCommission: 639.18, partnerCommissionFormatted: 639.18, status: paid } }/div>h3 idpartner-statement-detail-api-partner-statement-detail>Partner Statement Detail ( /api/partner-statement-detail )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/partner-statement-detail/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Partner/li>li>strong>Required Role:/strong> Partner API Access/li>/ul>p>The API returns detailed information about a specific partner statement. Aggregate data is returned along withline item level data for each underlying merchant statement./p>p>Use the merchant invoice id with the em>Merchant Statement Detail/em> API and the em>Partner Commission Breakdown/em> API to get the merchant statement and the card brand fee cost breakdown respectively./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/partner-statement-detail HTTP/1.1Host: api.blockchyp.comContent-Length: 54Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:4725705ce63983c1acd0a929d4bdc06530d02c46eb7a5f2b6cadd8319b23b38dNonce: c3c7be79ecd5e41a0dbe2327213c9e742d562375975fc31a63df97ab936b60b5Timestamp: 2021-05-20T13:39:51Z{ test: false, timeout: 120 statementId: SCH34K3J7005EJNAJBKYEIAAI}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: , id: SCH34K3J7005EJNAJBKYEIAAI, partnerId: Y5F3U5NQ7006ZBSUAJBKYEIAAU, partnerName: Demo Partner, Inc., statementDate: 2023-10-23T20:14:06Z, totalVolume: 548483.05, totalVolumeFormatted: 548,483.05, transactionCount: 12175, partnerCommission: 395.15, partnerCommissionFormatted: 395.15, partnerCommissionsOnVolume: 0.0007, partnerCommissionsOnVolumeFormatted: 0.07%, status: paid, lineItems: { id: UV7DEJLR4AI65OUEAJBKYEIAAM, invoiceId: UV7DEJLR4A700OUEAJBKYEIAAM, totalFees: 8058.21, totalFeesFormatted: 8,058.21, totalFeesOnVolume: 0.0166, totalFeesOnVolumeFormatted: 1.66%, merchantId: W5JCF4700I6ZE6KAJBKYEIAAI, merchantName: Taco Tuesday, Inc., dbaName: Don Juaquins, statementDate: 2023-09-30T04:28:21Z, volume: 486611.83, volumeFormatted: 486,611.83, transactionCount: 9628, interchange: 6175.64, interchangeFormatted: 6,175.64, interchangeOnVolume: 0.0127, interchangeOnVolumeFormatted: 1.27%, assessments: 653.05, assessmentsFormatted: 653.05, assessmentsOnVolume: 0.0013, assessmentsOnVolumeFormatted: 0.13%, partnerCommission: 332.88, partnerCommissionFormatted: 332.88, buyRate: 569.85, buyRateFormatted: 569.85, hardCosts: 215.83, hardCostsFormatted: 215.83 }, { id: UV7LJ4LR4AI65OUEAJBKYEIAAM, invoiceId: UV7DEJLR4A700OUEAJBKYEIAAM, totalFees: 1237.88, totalFeesFormatted: 1,237.88, totalFeesOnVolume: 0.02, totalFeesOnVolumeFormatted: 2%, merchantId: EINES7004I6ZDWLAJBKYEIAAM, merchantName: Kneaders, dbaName: Kneaders, statementDate: 2023-09-30T04:28:17Z, volume: 61871.22, volumeFormatted: 61,871.22, transactionCount: 2547, interchange: 887.84, interchangeFormatted: 887.84, interchangeOnVolume: 0.0143, interchangeOnVolumeFormatted: 1.43%, assessments: 81.65, assessmentsFormatted: 81.65, assessmentsOnVolume: 0.0013, assessmentsOnVolumeFormatted: 0.13%, partnerCommission: 62.27, partnerCommissionFormatted: 62.27, buyRate: 130.66, buyRateFormatted: 130.66, hardCosts: 54.7, hardCostsFormatted: 54.70 }, { id: UV7WP6LR4AI65OUEAJBKYEIAAM, invoiceId: UV7DEJLR4A700OUEAJBKYEIAAM, totalFees: 5, totalFeesFormatted: 5.00, totalFeesOnVolume: 0, totalFeesOnVolumeFormatted: 0%, merchantId: 2IHUDFHI7006ZKK3AJBKYEIAAQ, merchantName: DP Cheesesteaks, dbaName: DP Cheesesteaks, statementDate: 2023-09-30T04:28:53Z, volume: 0, volumeFormatted: 0.00, transactionCount: 0, interchange: 0, interchangeFormatted: 0.00, interchangeOnVolume: 0, interchangeOnVolumeFormatted: 0%, assessments: 0, assessmentsFormatted: 0.00, assessmentsOnVolume: 0, assessmentsOnVolumeFormatted: 0%, partnerCommission: 0, partnerCommissionFormatted: 0.00, buyRate: 5, buyRateFormatted: 5.00, hardCosts: 0, hardCostsFormatted: 0.00 } , adjustments: , disbursements: { id: CP7VPK3STQI65OUEAJBKYEIAAM, timestamp: 2023-10-24T19:08:11Z, transactionType: charge, paymentType: ACH, maskedPan: *****0000, pending: false, approved: true, responseDescription: , amount: 395.15, amountFormatted: 395.15 } }/div>h3 idmerchant-invoices-api-merchant-invoice-list>Merchant Invoices ( /api/merchant-invoice-list )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/merchant-invoice-list/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Partner or Merchant/li>li>strong>Required Role:/strong> Partner API Access or Merchant API /li>/ul>p>The API returns a list of merchant statements and invoices. By default, all invoices are returned with the most recentstatements listed first. Optional date parameters (code>startDate/code> and code>endDate/code>) can be used to filter statements by daterange. /p>p>The code>invoiceType/code> parameter can also be used to filter invoices by type. Invoices could be conventional invoices, suchas those generated when ordering terminals or gift cards, or invoices could be merchant statements./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/merchant-statement-list HTTP/1.1Host: api.blockchyp.comContent-Length: 54Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:4725705ce63983c1acd0a929d4bdc06530d02c46eb7a5f2b6cadd8319b23b38dNonce: c3c7be79ecd5e41a0dbe2327213c9e742d562375975fc31a63df97ab936b60b5Timestamp: 2021-05-20T13:39:51Z{ test: false, timeout: 120, merchantId: YXIYN627JEI700BWAJBKYEIAAQ}Response:HTTP/1.1 200 OK{success: true,error: ,responseDescription: ,invoices: { id: YXIYN627JEI65FBWAJBKYEIAAQ, dateCreated: 2023-09-30T04:28:21Z, grandTotal: 8058.21, grandTotalFormatted: 8,058.21, status: paid, invoiceType: statement, paid: true }, { id: OEXJSDSIPII65NU4AJBKYEIAAM, dateCreated: 2023-09-01T03:48:48Z, grandTotal: 7623.67, grandTotalFormatted: 7,623.67, status: paid, invoiceType: statement, paid: true }, { id: IC2W2YBQDYI65OGFAJBKYEIAAY, dateCreated: 2023-08-01T03:48:23Z, grandTotal: 7927.52, grandTotalFormatted: 7,927.52, status: paid, invoiceType: statement, paid: true } }/div>h3 idmerchant-invoice-detail-api-merchant-invoice-detail>Merchant Invoice Detail ( /api/merchant-invoice-detail )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/merchant-invoice-detail/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Partner/li>li>strong>Required Role:/strong> Partner API Access/li>/ul>p>The API returns detailed information about a specific merchant statement or invoice./p>p>All line items are returned a topographically sorted tree modeling the nested line item structure of the invoice. Details about any payments posted against the invoice are returned./p>p>It the invoice is a merchant statement, details about every merchant deposit that occurred during the statement periodare also returned./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/merchant_invoice_detail HTTP/1.1Host: api.blockchyp.comContent-Length: 54Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:4725705ce63983c1acd0a929d4bdc06530d02c46eb7a5f2b6cadd8319b23b38dNonce: c3c7be79ecd5e41a0dbe2327213c9e742d562375975fc31a63df97ab936b60b5Timestamp: 2021-05-20T13:39:51Z{ test: false, timeout: 120}Response:HTTP/1.1 200 OK{success: true,error: ,responseDescription: ,id: YXIYN627JEI6700WAJBKYEIAAQ,merchantId: W5JCF4NVX700ZE6KAJBKYEIAAI,corporateName: Improv Olympic,dbaName: Improv Olympic,dateCreated: 2023-09-30T04:28:21Z,status: paid,invoiceType: statement,pricingType: interchange,paid: true,grandTotal: 8058.21,grandTotalFormatted: 8,058.21,subtotal: 8058.21,subotalFormatted: 8,058.21,taxTotal: 0,taxTotalFormatted: 0.00,shippingCost: 0,shippingCostFormatted: 0.00,balanceDue: 0,balanceDueFormatted: 0.00,shippingAddress: {address1: 1060 W Addison,address2: ,city: Chicago,stateOrProvince: IL,postalCode: 60446,countryCode: ,latitude: 0,longitude: 0},billingAddress: {address1: 1060 W Addison,address2: ,city: Chicago,stateOrProvince: IL,postalCode: 60446,countryCode: ,latitude: 0,longitude: 0},lineItems: {id: SIRMMLDU6MI65KNZTYA4RH54WI,lineType: header,productId: ,quantity: 0,description: Interchange Fees,explanation: These are fees the credit card brands charge. Seems fair. They work hard on those logos.,transactionCount: 0,volume: 0,volumeFormatted: 0.00,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0,transactionPercentageFormatted: 0%,price: 0,priceFormatted: ,priceExtended: 6175.64,priceExtendedFormatted: 6,175.64,lineItems: {id: SKHU4WTU6MI65KNZTYA4RH54WI,lineType: header,productId: ,quantity: 0,description: Visa,explanation: ,transactionCount: 0,volume: 0,volumeFormatted: 0.00,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0,transactionPercentageFormatted: 0%,price: 0,priceFormatted: ,priceExtended: 2247.73,priceExtendedFormatted: 2,247.73,lineItems: {id: SISHUOTU6MI65KNZTYA4RH54WI,lineType: volume,productId: ,quantity: 1,description: VS Electronic,explanation: ,transactionCount: 7,volume: 149.85,volumeFormatted: 149.85,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0.011,transactionPercentageFormatted: 1.1%,price: 1.6400000000000001,priceFormatted: 149.85 @ 1.1%,priceExtended: 1.6400000000000001,priceExtendedFormatted: 1.64,lineItems: null},{id: SISR7RTU6MI65KNZTYA4RH54WI,lineType: volume,productId: ,quantity: 1,description: VS Credit Voucher Non PT Credit,explanation: ,transactionCount: -1,volume: -122.64,volumeFormatted: -122.64,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0.0176,transactionPercentageFormatted: 1.76%,price: -2.16,priceFormatted: -122.64 @ 1.76%,priceExtended: -2.16,priceExtendedFormatted: -2.16,lineItems: null},{id: SITGU4DU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: VS CPS Retail Check Debit,explanation: ,transactionCount: 395,volume: 16704.31,volumeFormatted: 16,704.31,perTransactionFee: 0.15,perTransactionFeeFormatted: 0.15,transactionPercentage: 0.008,transactionPercentageFormatted: 0.8%,price: 192.9,priceFormatted: $16,704.31 @ 0.8%\n395 x $0.15,priceExtended: 192.9,priceExtendedFormatted: 192.90,lineItems: null},{id: SITVVLDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: VS CPS Small Ticket Debit,explanation: ,transactionCount: 108,volume: 1029.89,volumeFormatted: 1,029.89,perTransactionFee: 0.04,perTransactionFeeFormatted: 0.04,transactionPercentage: 0.0155,transactionPercentageFormatted: 1.55%,price: 20.29,priceFormatted: $1,029.89 @ 1.55%\n108 x $0.04,priceExtended: 20.29,priceExtendedFormatted: 20.29,lineItems: null},{id: SIUB74DU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: VS Business Tr1 Prod 2,explanation: ,transactionCount: 3,volume: 50.23,volumeFormatted: 50.23,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.019,transactionPercentageFormatted: 1.9%,price: 1.26,priceFormatted: $50.23 @ 1.9%\n3 x $0.10,priceExtended: 1.26,priceExtendedFormatted: 1.26,lineItems: null},{id: SIUOC7TU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: VS US Corporate Card - Card Present,explanation: ,transactionCount: 1,volume: 92.43,volumeFormatted: 92.43,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.025,transactionPercentageFormatted: 2.5%,price: 2.41,priceFormatted: $92.43 @ 2.5%\n1 x $0.10,priceExtended: 2.41,priceExtendedFormatted: 2.41,lineItems: null},{id: SIU3E4DU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: VS US Purchasing Card - Card Present,explanation: ,transactionCount: 2,volume: 108.21,volumeFormatted: 108.21,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.025,transactionPercentageFormatted: 2.5%,price: 2.9,priceFormatted: $108.21 @ 2.5%\n2 x $0.10,priceExtended: 2.9,priceExtendedFormatted: 2.90,lineItems: null},{id: SIVFAGDU6MI65KNZTYA4RH54WI,lineType: volume,productId: ,quantity: 1,description: VS InterReg Corporate,explanation: ,transactionCount: 1,volume: 66.89,volumeFormatted: 66.89,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0.02,transactionPercentageFormatted: 2%,price: 1.34,priceFormatted: 66.89 @ 2%,priceExtended: 1.34,priceExtendedFormatted: 1.34,lineItems: null},{id: SIVVLHTU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: VS Business Purchase Retail Prepaid,explanation: ,transactionCount: 17,volume: 405.08,volumeFormatted: 405.08,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.0215,transactionPercentageFormatted: 2.15%,price: 10.41,priceFormatted: $405.08 @ 2.15%\n17 x $0.10,priceExtended: 10.41,priceExtendedFormatted: 10.41,lineItems: null},{id: SIWYH6TU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: VS Business Tr4 Prod 2,explanation: ,transactionCount: 14,volume: 2233.69,volumeFormatted: 2,233.69,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.022,transactionPercentageFormatted: 2.2%,price: 50.54,priceFormatted: $2,233.69 @ 2.2%\n14 x $0.10,priceExtended: 50.54,priceExtendedFormatted: 50.54,lineItems: null},{id: SIXRNITU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: VS Business Tr 5 Prod 2,explanation: ,transactionCount: 9,volume: 5741.09,volumeFormatted: 5,741.09,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.0225,transactionPercentageFormatted: 2.25%,price: 130.08,priceFormatted: $5,741.09 @ 2.25%\n9 x $0.10,priceExtended: 130.08,priceExtendedFormatted: 130.08,lineItems: null},{id: SIYFMIDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: VS VT Product 2,explanation: ,transactionCount: 135,volume: 7432.45,volumeFormatted: 7,432.45,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.0151,transactionPercentageFormatted: 1.51%,price: 125.74,priceFormatted: $7,432.45 @ 1.51%\n135 x $0.10,priceExtended: 125.74,priceExtendedFormatted: 125.74,lineItems: null},{id: SIYSIJDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: VS VTR Product 2,explanation: ,transactionCount: 77,volume: 5828.89,volumeFormatted: 5,828.89,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.0165,transactionPercentageFormatted: 1.65%,price: 103.82,priceFormatted: $5,828.89 @ 1.65%\n77 x $0.10,priceExtended: 103.82,priceExtendedFormatted: 103.82,lineItems: null},{id: SIZWGEDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: VS VIN Product 2,explanation: ,transactionCount: 462,volume: 25098.56,volumeFormatted: 25,098.56,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.0165,transactionPercentageFormatted: 1.65%,price: 460.15,priceFormatted: $25,098.56 @ 1.65%\n462 x $0.10,priceExtended: 460.15,priceExtendedFormatted: 460.15,lineItems: null},{id: SJJE3QDU6MI65KNZTYA4RH54WI,lineType: volume,productId: ,quantity: 1,description: VS Premium Card,explanation: ,transactionCount: 2,volume: 118.17,volumeFormatted: 118.17,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0.018,transactionPercentageFormatted: 1.8%,price: 2.13,priceFormatted: 118.17 @ 1.8%,priceExtended: 2.13,priceExtendedFormatted: 2.13,lineItems: null},{id: SJJYHNTU6MI65KNZTYA4RH54WI,lineType: volume,productId: ,quantity: 1,description: VS InterReg Super Premium,explanation: ,transactionCount: 1,volume: 20.06,volumeFormatted: 20.06,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0.0197,transactionPercentageFormatted: 1.97%,price: 0.4,priceFormatted: 20.06 @ 1.97%,priceExtended: 0.4,priceExtendedFormatted: 0.40,lineItems: null},{id: SJKTHFTU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: VS Business Tr2 Prod 2,explanation: ,transactionCount: 47,volume: 2525.34,volumeFormatted: 2,525.34,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.0205,transactionPercentageFormatted: 2.05%,price: 56.54,priceFormatted: $2,525.34 @ 2.05%\n47 x $0.10,priceExtended: 56.54,priceExtendedFormatted: 56.54,lineItems: null},{id: SJK22MDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: VS Business Tr3 Prod 2,explanation: ,transactionCount: 13,volume: 1178.42,volumeFormatted: 1,178.42,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.021,transactionPercentageFormatted: 2.1%,price: 26.04,priceFormatted: $1,178.42 @ 2.1%\n13 x $0.10,priceExtended: 26.04,priceExtendedFormatted: 26.04,lineItems: null},{id: SJLW7HTU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: VS InterReg Regulated Debit,explanation: ,transactionCount: 1,volume: 17.83,volumeFormatted: 17.83,perTransactionFee: 0.22,perTransactionFeeFormatted: 0.22,transactionPercentage: 0.0005,transactionPercentageFormatted: 0.05%,price: 0.23,priceFormatted: $17.83 @ 0.05%\n1 x $0.22,priceExtended: 0.23,priceExtendedFormatted: 0.23,lineItems: null},{id: SJMGLVDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: VS CPS Small Ticket Pp,explanation: ,transactionCount: 59,volume: 521.88,volumeFormatted: 521.88,perTransactionFee: 0.05,perTransactionFeeFormatted: 0.05,transactionPercentage: 0.016,transactionPercentageFormatted: 1.6%,price: 11.3,priceFormatted: $521.88 @ 1.6%\n59 x $0.05,priceExtended: 11.3,priceExtendedFormatted: 11.30,lineItems: null},{id: SJMTTIDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: VS CPS Small Ticket Regulated,explanation: ,transactionCount: 704,volume: 6734.91,volumeFormatted: 6,734.91,perTransactionFee: 0.22,perTransactionFeeFormatted: 0.22,transactionPercentage: 0.0005,transactionPercentageFormatted: 0.05%,price: 158.76,priceFormatted: $6,734.91 @ 0.05%\n704 x $0.22,priceExtended: 158.76,priceExtendedFormatted: 158.76,lineItems: null},{id: SJNANPTU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: VS US Regulated Debit,explanation: ,transactionCount: 3228,volume: 168064.33,volumeFormatted: 168,064.33,perTransactionFee: 0.22,perTransactionFeeFormatted: 0.22,transactionPercentage: 0.0005,transactionPercentageFormatted: 0.05%,price: 794.27,priceFormatted: $168,064.33 @ 0.05%\n3,228 x $0.22,priceExtended: 794.27,priceExtendedFormatted: 794.27,lineItems: null},{id: SJNUHRTU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: VS CPS Retail Pp,explanation: ,transactionCount: 147,volume: 5200.96,volumeFormatted: 5,200.96,perTransactionFee: 0.15,perTransactionFeeFormatted: 0.15,transactionPercentage: 0.0115,transactionPercentageFormatted: 1.15%,price: 81.9,priceFormatted: $5,200.96 @ 1.15%\n147 x $0.15,priceExtended: 81.9,priceExtendedFormatted: 81.90,lineItems: null},{id: SJN6L3DU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: VS Business Card CP Debit,explanation: ,transactionCount: 21,volume: 748.4,volumeFormatted: 748.40,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.017,transactionPercentageFormatted: 1.7%,price: 14.84,priceFormatted: $748.40 @ 1.7%\n21 x $0.10,priceExtended: 14.84,priceExtendedFormatted: 14.84,lineItems: null}},{id: SKIIHRDU6MI65KNZTYA4RH54WI,lineType: header,productId: ,quantity: 0,description: Mastercard,explanation: ,transactionCount: 0,volume: 0,volumeFormatted: 0.00,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0,transactionPercentageFormatted: 0%,price: 0,priceFormatted: ,priceExtended: 1886.79,priceExtendedFormatted: 1,886.79,lineItems: {id: SJOJH2DU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: MC Merit III Credit,explanation: ,transactionCount: 53,volume: 2880.67,volumeFormatted: 2,880.67,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.0165,transactionPercentageFormatted: 1.65%,price: 52.81,priceFormatted: $2,880.67 @ 1.65%\n53 x $0.10,priceExtended: 52.81,priceExtendedFormatted: 52.81,lineItems: null},{id: SJOUL7TU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: MC Corporate Data Rate 1,explanation: ,transactionCount: 17,volume: 741.57,volumeFormatted: 741.57,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.0265,transactionPercentageFormatted: 2.65%,price: 21.32,priceFormatted: $741.57 @ 2.65%\n17 x $0.10,priceExtended: 21.32,priceExtendedFormatted: 21.32,lineItems: null},{id: SJPBD4DU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: MC Commercial Rate 1 Large Market,explanation: ,transactionCount: 14,volume: 1254.57,volumeFormatted: 1,254.57,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.027,transactionPercentageFormatted: 2.7%,price: 35.29,priceFormatted: $1,254.57 @ 2.7%\n14 x $0.10,priceExtended: 35.29,priceExtendedFormatted: 35.29,lineItems: null},{id: SJPG3PDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: MC Enhanced Merit III Base,explanation: ,transactionCount: 170,volume: 8911.28,volumeFormatted: 8,911.28,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.018,transactionPercentageFormatted: 1.8%,price: 177.26,priceFormatted: $8,911.28 @ 1.8%\n170 x $0.10,priceExtended: 177.26,priceExtendedFormatted: 177.26,lineItems: null},{id: SJPRT5TU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: MC Merit III Debit,explanation: ,transactionCount: 236,volume: 7732.66,volumeFormatted: 7,732.66,perTransactionFee: 0.15,perTransactionFeeFormatted: 0.15,transactionPercentage: 0.0105,transactionPercentageFormatted: 1.05%,price: 116.64,priceFormatted: $7,732.66 @ 1.05%\n236 x $0.15,priceExtended: 116.64,priceExtendedFormatted: 116.64,lineItems: null},{id: SJREIKDU6MI65KNZTYA4RH54WI,lineType: volume,productId: ,quantity: 1,description: MC Consumer Credit Refund Group 4,explanation: ,transactionCount: -1,volume: -50.16,volumeFormatted: -50.16,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0.0175,transactionPercentageFormatted: 1.75%,price: -0.88,priceFormatted: -50.16 @ 1.75%,priceExtended: -0.88,priceExtendedFormatted: -0.88,lineItems: null},{id: SJRYUBDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: MC World Merit III,explanation: ,transactionCount: 122,volume: 8218.31,volumeFormatted: 8,218.31,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.019,transactionPercentageFormatted: 1.9%,price: 168.41,priceFormatted: $8,218.31 @ 1.9%\n122 x $0.10,priceExtended: 168.41,priceExtendedFormatted: 168.41,lineItems: null},{id: SJSGDEDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: MC World Elite Merit III,explanation: ,transactionCount: 368,volume: 27357.29,volumeFormatted: 27,357.29,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.023,transactionPercentageFormatted: 2.3%,price: 666,priceFormatted: $27,357.29 @ 2.3%\n368 x $0.10,priceExtended: 666,priceExtendedFormatted: 666.00,lineItems: null},{id: SJTCAKTU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: MC Business Level 4 Data Rate I,explanation: ,transactionCount: 1,volume: 33.44,volumeFormatted: 33.44,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.0295,transactionPercentageFormatted: 2.95%,price: 1.09,priceFormatted: $33.44 @ 2.95%\n1 x $0.10,priceExtended: 1.09,priceExtendedFormatted: 1.09,lineItems: null},{id: SJTQI7DU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: MC Business Level 1 Data Rate I,explanation: ,transactionCount: 1,volume: 45.68,volumeFormatted: 45.68,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.0265,transactionPercentageFormatted: 2.65%,price: 1.31,priceFormatted: $45.68 @ 2.65%\n1 x $0.10,priceExtended: 1.31,priceExtendedFormatted: 1.31,lineItems: null},{id: SJUXIZDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: MC Business Level 5 Data Rate I,explanation: ,transactionCount: 2,volume: 77.86,volumeFormatted: 77.86,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.03,transactionPercentageFormatted: 3%,price: 2.5300000000000002,priceFormatted: $77.86 @ 3%\n2 x $0.10,priceExtended: 2.5300000000000002,priceExtendedFormatted: 2.53,lineItems: null},{id: SJVBZ7DU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: MC Merit 3 Prepaid,explanation: ,transactionCount: 54,volume: 1187.43,volumeFormatted: 1,187.43,perTransactionFee: 0.15,perTransactionFeeFormatted: 0.15,transactionPercentage: 0.0115,transactionPercentageFormatted: 1.15%,price: 21.75,priceFormatted: $1,187.43 @ 1.15%\n54 x $0.15,priceExtended: 21.75,priceExtendedFormatted: 21.75,lineItems: null},{id: SJVTOGDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: MC Small Ticket Card Present,explanation: ,transactionCount: 3,volume: 11.56,volumeFormatted: 11.56,perTransactionFee: 0.02,perTransactionFeeFormatted: 0.02,transactionPercentage: 0.0165,transactionPercentageFormatted: 1.65%,price: 0.24,priceFormatted: $11.56 @ 1.65%\n3 x $0.02,priceExtended: 0.24,priceExtendedFormatted: 0.24,lineItems: null},{id: SJWPPWDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: MC World Small Ticket Card Present,explanation: ,transactionCount: 1,volume: 4.45,volumeFormatted: 4.45,perTransactionFee: 0.02,perTransactionFeeFormatted: 0.02,transactionPercentage: 0.019,transactionPercentageFormatted: 1.9%,price: 0.1,priceFormatted: $4.45 @ 1.9%\n1 x $0.02,priceExtended: 0.1,priceExtendedFormatted: 0.10,lineItems: null},{id: SJW6HSDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: MC World Elite Small Ticket Card Present,explanation: ,transactionCount: 8,volume: 29.06,volumeFormatted: 29.06,perTransactionFee: 0.02,perTransactionFeeFormatted: 0.02,transactionPercentage: 0.023,transactionPercentageFormatted: 2.3%,price: 0.84,priceFormatted: $29.06 @ 2.3%\n8 x $0.02,priceExtended: 0.84,priceExtendedFormatted: 0.84,lineItems: null},{id: SJXDSVDU6MI65KNZTYA4RH54WI,lineType: volume,productId: ,quantity: 1,description: MC Consumer Rate 2-Card Present Core,explanation: ,transactionCount: 8,volume: 409.93,volumeFormatted: 409.93,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0.011,transactionPercentageFormatted: 1.1%,price: 4.52,priceFormatted: 409.93 @ 1.1%,priceExtended: 4.52,priceExtendedFormatted: 4.52,lineItems: null},{id: SJXRIZDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: MC High Value Merit III Base 1,explanation: ,transactionCount: 43,volume: 5656.44,volumeFormatted: 5,656.44,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.023,transactionPercentageFormatted: 2.3%,price: 134.42,priceFormatted: $5,656.44 @ 2.3%\n43 x $0.10,priceExtended: 134.42,priceExtendedFormatted: 134.42,lineItems: null},{id: SKCCGGDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: MC Business Level 2 Data Rate I,explanation: ,transactionCount: 1,volume: 530.87,volumeFormatted: 530.87,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.028,transactionPercentageFormatted: 2.8%,price: 14.96,priceFormatted: $530.87 @ 2.8%\n1 x $0.10,priceExtended: 14.96,priceExtendedFormatted: 14.96,lineItems: null},{id: SKCWQXTU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: MC US Cons Regulated POS Debit w/Fraud Adj,explanation: ,transactionCount: 1956,volume: 75924.61,volumeFormatted: 75,924.61,perTransactionFee: 0.22,perTransactionFeeFormatted: 0.22,transactionPercentage: 0.0005,transactionPercentageFormatted: 0.05%,price: 468.18,priceFormatted: $75,924.61 @ 0.05%\n1,956 x $0.22,priceExtended: 468.18,priceExtendedFormatted: 468.18,lineItems: null}},{id: SKIQSIDU6MI65KNZTYA4RH54WI,lineType: header,productId: ,quantity: 0,description: American Express,explanation: ,transactionCount: 0,volume: 0,volumeFormatted: 0.00,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0,transactionPercentageFormatted: 0%,price: 0,priceFormatted: ,priceExtended: 418.89,priceExtendedFormatted: 418.89,lineItems: {id: SKC6Z2DU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: AM Retail Tier 1,explanation: ,transactionCount: 106,volume: 3483.88,volumeFormatted: 3,483.88,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.016,transactionPercentageFormatted: 1.6%,price: 66.31,priceFormatted: $3,483.88 @ 1.6%\n106 x $0.10,priceExtended: 66.31,priceExtendedFormatted: 66.31,lineItems: null},{id: SKDHTWDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: AM Retail Tier 2,explanation: ,transactionCount: 50,volume: 9545.76,volumeFormatted: 9,545.76,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.0195,transactionPercentageFormatted: 1.95%,price: 191.15,priceFormatted: $9,545.76 @ 1.95%\n50 x $0.10,priceExtended: 191.15,priceExtendedFormatted: 191.15,lineItems: null},{id: SKDQXDDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: AM Retail Tier 3,explanation: ,transactionCount: 3,volume: 6693.79,volumeFormatted: 6,693.79,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.024,transactionPercentageFormatted: 2.4%,price: 160.95,priceFormatted: $6,693.79 @ 2.4%\n3 x $0.10,priceExtended: 160.95,priceExtendedFormatted: 160.95,lineItems: null},{id: SKEOQ5TU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: AM Prepaid Tier 1,explanation: ,transactionCount: 1,volume: 27.85,volumeFormatted: 27.85,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.0135,transactionPercentageFormatted: 1.35%,price: 0.48,priceFormatted: $27.85 @ 1.35%\n1 x $0.10,priceExtended: 0.48,priceExtendedFormatted: 0.48,lineItems: null}},{id: SKJSGITU6MI65KNZTYA4RH54WI,lineType: header,productId: ,quantity: 0,description: Discover,explanation: ,transactionCount: 0,volume: 0,volumeFormatted: 0.00,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0,transactionPercentageFormatted: 0%,price: 0,priceFormatted: ,priceExtended: 462.86,priceExtendedFormatted: 462.86,lineItems: {id: SKFJMHDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: DS PSL Retail Rewards,explanation: ,transactionCount: 191,volume: 10693.91,volumeFormatted: 10,693.91,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.0172,transactionPercentageFormatted: 1.72%,price: 203.06,priceFormatted: $10,693.91 @ 1.72%\n191 x $0.10,priceExtended: 203.06,priceExtendedFormatted: 203.06,lineItems: null},{id: SKFQRGTU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: DS PSL Retail DB,explanation: ,transactionCount: 24,volume: 821.15,volumeFormatted: 821.15,perTransactionFee: 0.16,perTransactionFeeFormatted: 0.16,transactionPercentage: 0.011,transactionPercentageFormatted: 1.1%,price: 12.89,priceFormatted: $821.15 @ 1.1%\n24 x $0.16,priceExtended: 12.89,priceExtendedFormatted: 12.89,lineItems: null},{id: SKGB6HTU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: DS Commercial Electronic Submission Level,explanation: ,transactionCount: 39,volume: 2271.61,volumeFormatted: 2,271.61,perTransactionFee: 0.15,perTransactionFeeFormatted: 0.15,transactionPercentage: 0.0245,transactionPercentageFormatted: 2.45%,price: 61.5,priceFormatted: $2,271.61 @ 2.45%\n39 x $0.15,priceExtended: 61.5,priceExtendedFormatted: 61.50,lineItems: null},{id: SKGRGQTU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: DS PSL - Retail Prepaid,explanation: ,transactionCount: 2,volume: 83.57,volumeFormatted: 83.57,perTransactionFee: 0.16,perTransactionFeeFormatted: 0.16,transactionPercentage: 0.0112,transactionPercentageFormatted: 1.12%,price: 1.25,priceFormatted: $83.57 @ 1.12%\n2 x $0.16,priceExtended: 1.25,priceExtendedFormatted: 1.25,lineItems: null},{id: SKGXGCTU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: DS PSL Retail PR,explanation: ,transactionCount: 36,volume: 10176.1,volumeFormatted: 10,176.10,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.0174,transactionPercentageFormatted: 1.74%,price: 180.69,priceFormatted: $10,176.10 @ 1.74%\n36 x $0.10,priceExtended: 180.69,priceExtendedFormatted: 180.69,lineItems: null},{id: SKHFGVTU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: DS Retail (Premium Plus),explanation: ,transactionCount: 3,volume: 140.99,volumeFormatted: 140.99,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.0225,transactionPercentageFormatted: 2.25%,price: 3.4699999999999998,priceFormatted: $140.99 @ 2.25%\n3 x $0.10,priceExtended: 3.4699999999999998,priceExtendedFormatted: 3.47,lineItems: null}},{id: SKKAFETU6MI65KNZTYA4RH54WI,lineType: header,productId: ,quantity: 0,description: Debit,explanation: ,transactionCount: 0,volume: 0,volumeFormatted: 0.00,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0,transactionPercentageFormatted: 0%,price: 0,priceFormatted: ,priceExtended: 1159.37,priceExtendedFormatted: 1,159.37,lineItems: {id: SI2EVDDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: Visa Signature Preferred Product 2,explanation: ,transactionCount: 627,volume: 49779.42,volumeFormatted: 49,779.42,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.021,transactionPercentageFormatted: 2.1%,price: 1108,priceFormatted: $49,779.42 @ 2.1%\n627 x $0.10,priceExtended: 1108,priceExtendedFormatted: 1,108.00,lineItems: null},{id: SI3AFIDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: Visa VIQ Product 2,explanation: ,transactionCount: 22,volume: 1942.96,volumeFormatted: 1,942.96,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.021,transactionPercentageFormatted: 2.1%,price: 42.98,priceFormatted: $1,942.96 @ 2.1%\n22 x $0.10,priceExtended: 42.98,priceExtendedFormatted: 42.98,lineItems: null},{id: SJSOWBTU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: Commercial Data Rate 1 Level 3,explanation: ,transactionCount: 12,volume: 252.5,volumeFormatted: 252.50,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.0285,transactionPercentageFormatted: 2.85%,price: 8.39,priceFormatted: $252.50 @ 2.85%\n12 x $0.10,priceExtended: 8.39,priceExtendedFormatted: 8.39,lineItems: null}}},{id: SKKVUUTU6MI65KNZTYA4RH54WI,lineType: header,productId: ,quantity: 0,description: Other Passthrough Fees,explanation: These are other bank and card brand fees we have no control over.,transactionCount: 0,volume: 0,volumeFormatted: 0.00,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0,transactionPercentageFormatted: 0%,price: 0,priceFormatted: ,priceExtended: 657.56,priceExtendedFormatted: 657.56,lineItems: {id: SKPZ7PDU6MI65KNZTYA4RH54WI,lineType: header,productId: ,quantity: 0,description: Visa,explanation: ,transactionCount: 0,volume: 0,volumeFormatted: 0.00,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0,transactionPercentageFormatted: 0%,price: 0,priceFormatted: ,priceExtended: 404.3,priceExtendedFormatted: 404.30,lineItems: {id: SKLL5WDU6MI65KNZTYA4RH54WI,lineType: volume,productId: ,quantity: 1,description: VS-IAF,explanation: ,transactionCount: 13,volume: 454.15,volumeFormatted: 454.15,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0.0045,transactionPercentageFormatted: 0.45%,price: 2.05,priceFormatted: 454.15 @ 0.45%,priceExtended: 2.05,priceExtendedFormatted: 2.05,lineItems: null},{id: SKLXH4DU6MI65KNZTYA4RH54WI,lineType: volume,productId: ,quantity: 1,description: VS-ASSMNT CREDIT,explanation: ,transactionCount: 1414,volume: 102098.64,volumeFormatted: 102,098.64,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0.0014,transactionPercentageFormatted: 0.14%,price: 142.96,priceFormatted: 102,098.64 @ 0.14%,priceExtended: 142.96,priceExtendedFormatted: 142.96,lineItems: null},{id: SKMDZ5DU6MI65KNZTYA4RH54WI,lineType: volume,productId: ,quantity: 1,description: VS-ASSMNT DEBIT,explanation: ,transactionCount: 4689,volume: 199695.61,volumeFormatted: 199,695.61,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0.0013,transactionPercentageFormatted: 0.13%,price: 259.29,priceFormatted: 199,695.61 @ 0.13%,priceExtended: 259.29,priceExtendedFormatted: 259.29,lineItems: null}},{id: SKRPJKTU6MI65KNZTYA4RH54WI,lineType: header,productId: ,quantity: 0,description: Mastercard,explanation: ,transactionCount: 0,volume: 0,volumeFormatted: 0.00,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0,transactionPercentageFormatted: 0%,price: 0,priceFormatted: ,priceExtended: 186.8,priceExtendedFormatted: 186.80,lineItems: {id: SKMPSADU6MI65KNZTYA4RH54WI,lineType: volume,productId: ,quantity: 1,description: MC-ACQ Brnd Vol ABV,explanation: ,transactionCount: 4,volume: 8898.36,volumeFormatted: 8,898.36,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0.0014,transactionPercentageFormatted: 0.14%,price: 12.46,priceFormatted: 8,898.36 @ 0.14%,priceExtended: 12.46,priceExtendedFormatted: 12.46,lineItems: null},{id: SKM43CTU6MI65KNZTYA4RH54WI,lineType: volume,productId: ,quantity: 1,description: MC-ACQ Brand Volume,explanation: ,transactionCount: 3066,volume: 132361.82,volumeFormatted: 132,361.82,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0.0013,transactionPercentageFormatted: 0.13%,price: 171.88,priceFormatted: 132,361.82 @ 0.13%,priceExtended: 171.88,priceExtendedFormatted: 171.88,lineItems: null},{id: SKNRYJTU6MI65KNZTYA4RH54WI,lineType: volume,productId: ,quantity: 1,description: MC-CRBDR - Domestic,explanation: ,transactionCount: 8,volume: 409.93,volumeFormatted: 409.93,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0.006,transactionPercentageFormatted: 0.6%,price: 2.46,priceFormatted: 409.93 @ 0.6%,priceExtended: 2.46,priceExtendedFormatted: 2.46,lineItems: null}},{id: SKSBLWDU6MI65KNZTYA4RH54WI,lineType: header,productId: ,quantity: 0,description: American Express,explanation: ,transactionCount: 0,volume: 0,volumeFormatted: 0.00,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0,transactionPercentageFormatted: 0%,price: 0,priceFormatted: ,priceExtended: 32.6,priceExtendedFormatted: 32.60,lineItems: {id: SKN3NYDU6MI65KNZTYA4RH54WI,lineType: volume,productId: ,quantity: 1,description: AM-AM USASSMNTFEE,explanation: ,transactionCount: 160,volume: 19751.28,volumeFormatted: 19,751.28,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0.00165,transactionPercentageFormatted: 0.165%,price: 32.6,priceFormatted: 19,751.28 @ 0.165%,priceExtended: 32.6,priceExtendedFormatted: 32.60,lineItems: null}},{id: SMF43VTU6MI65KNZTYA4RH54WI,lineType: header,productId: ,quantity: 0,description: Discover,explanation: ,transactionCount: 0,volume: 0,volumeFormatted: 0.00,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0,transactionPercentageFormatted: 0%,price: 0,priceFormatted: ,priceExtended: 33.86,priceExtendedFormatted: 33.86,lineItems: {id: SKPDDGTU6MI65KNZTYA4RH54WI,lineType: volume,productId: ,quantity: 1,description: DS-DS Assessment,explanation: ,transactionCount: 295,volume: 24187.33,volumeFormatted: 24,187.33,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0.0014,transactionPercentageFormatted: 0.14%,price: 33.86,priceFormatted: 24,187.33 @ 0.14%,priceExtended: 33.86,priceExtendedFormatted: 33.86,lineItems: null}}},{id: SMHGCITU6MI65KNZTYA4RH54WI,lineType: header,productId: ,quantity: 0,description: BlockChyp Fees,explanation: These are the fees BlockChyp collects. We use them to keep the office stocked with La Croix and board games.,transactionCount: 0,volume: 0,volumeFormatted: 0.00,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0,transactionPercentageFormatted: 0%,price: 0,priceFormatted: ,priceExtended: 1215.01,priceExtendedFormatted: 1,215.01,lineItems: {id: SMJQHPDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: Chip-VS,explanation: ,transactionCount: 1320,volume: 90021.36,volumeFormatted: 90,021.36,perTransactionFee: 0.05,perTransactionFeeFormatted: 0.05,transactionPercentage: 0.001,transactionPercentageFormatted: 0.1%,price: 156.02,priceFormatted: $90,021.36 @ 0.1%\n1,320 x $0.05,priceExtended: 156.02,priceExtendedFormatted: 156.02,lineItems: null},{id: SMKSOWTU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: Chip-VD,explanation: ,transactionCount: 4630,volume: 198012.1,volumeFormatted: 198,012.10,perTransactionFee: 0.081,perTransactionFeeFormatted: 0.081,transactionPercentage: 0.001,transactionPercentageFormatted: 0.1%,price: 573.04,priceFormatted: $198,012.10 @ 0.1%\n4,630 x $0.081,priceExtended: 573.04,priceExtendedFormatted: 573.04,lineItems: null},{id: SMK3YBTU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: Chip-VB,explanation: ,transactionCount: 90,volume: 11996.3,volumeFormatted: 11,996.30,perTransactionFee: 0.05,perTransactionFeeFormatted: 0.05,transactionPercentage: 0.001,transactionPercentageFormatted: 0.1%,price: 16.5,priceFormatted: $11,996.30 @ 0.1%\n90 x $0.05,priceExtended: 16.5,priceExtendedFormatted: 16.50,lineItems: null},{id: SMLH33TU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: Chip-MC,explanation: ,transactionCount: 765,volume: 52950.24,volumeFormatted: 52,950.24,perTransactionFee: 0.05,perTransactionFeeFormatted: 0.05,transactionPercentage: 0.001,transactionPercentageFormatted: 0.1%,price: 91.2,priceFormatted: $52,950.24 @ 0.1%\n765 x $0.05,priceExtended: 91.2,priceExtendedFormatted: 91.20,lineItems: null},{id: SMLR3FDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: Chip-MD,explanation: ,transactionCount: 2220,volume: 84571.84,volumeFormatted: 84,571.84,perTransactionFee: 0.081,perTransactionFeeFormatted: 0.081,transactionPercentage: 0.001,transactionPercentageFormatted: 0.1%,price: 264.39,priceFormatted: $84,571.84 @ 0.1%\n2,220 x $0.081,priceExtended: 264.39,priceExtendedFormatted: 264.39,lineItems: null},{id: SMME3BTU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: Chip-MB,explanation: ,transactionCount: 30,volume: 2181.55,volumeFormatted: 2,181.55,perTransactionFee: 0.05,perTransactionFeeFormatted: 0.05,transactionPercentage: 0.001,transactionPercentageFormatted: 0.1%,price: 3.68,priceFormatted: $2,181.55 @ 0.1%\n30 x $0.05,priceExtended: 3.68,priceExtendedFormatted: 3.68,lineItems: null},{id: SMMO77DU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: Chip-AM,explanation: ,transactionCount: 159,volume: 19723.43,volumeFormatted: 19,723.43,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.002,transactionPercentageFormatted: 0.2%,price: 55.35,priceFormatted: $19,723.43 @ 0.2%\n159 x $0.10,priceExtended: 55.35,priceExtendedFormatted: 55.35,lineItems: null},{id: SMMXMXDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: Chip-DS,explanation: ,transactionCount: 230,volume: 21011,volumeFormatted: 21,011.00,perTransactionFee: 0.05,perTransactionFeeFormatted: 0.05,transactionPercentage: 0.001,transactionPercentageFormatted: 0.1%,price: 32.51,priceFormatted: $21,011.00 @ 0.1%\n230 x $0.05,priceExtended: 32.51,priceExtendedFormatted: 32.51,lineItems: null},{id: SMNKM3DU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: Chip-DD,explanation: ,transactionCount: 26,volume: 904.72,volumeFormatted: 904.72,perTransactionFee: 0.081,perTransactionFeeFormatted: 0.081,transactionPercentage: 0.001,transactionPercentageFormatted: 0.1%,price: 3.01,priceFormatted: $904.72 @ 0.1%\n26 x $0.081,priceExtended: 3.01,priceExtendedFormatted: 3.01,lineItems: null},{id: SMOB3PDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: Chip-DZ,explanation: ,transactionCount: 39,volume: 2271.61,volumeFormatted: 2,271.61,perTransactionFee: 0.05,perTransactionFeeFormatted: 0.05,transactionPercentage: 0.001,transactionPercentageFormatted: 0.1%,price: 4.22,priceFormatted: $2,271.61 @ 0.1%\n39 x $0.05,priceExtended: 4.22,priceExtendedFormatted: 4.22,lineItems: null},{id: SMRHRTTU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: Fallback-VS,explanation: ,transactionCount: 2,volume: 59.06,volumeFormatted: 59.06,perTransactionFee: 0.05,perTransactionFeeFormatted: 0.05,transactionPercentage: 0.001,transactionPercentageFormatted: 0.1%,price: 0.16,priceFormatted: $59.06 @ 0.1%\n2 x $0.05,priceExtended: 0.16,priceExtendedFormatted: 0.16,lineItems: null},{id: SMTKH2TU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: Fallback-VD,explanation: ,transactionCount: 4,volume: 235.21,volumeFormatted: 235.21,perTransactionFee: 0.081,perTransactionFeeFormatted: 0.081,transactionPercentage: 0.001,transactionPercentageFormatted: 0.1%,price: 0.56,priceFormatted: $235.21 @ 0.1%\n4 x $0.081,priceExtended: 0.56,priceExtendedFormatted: 0.56,lineItems: null},{id: SMT4OIDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: Fallback-MC,explanation: ,transactionCount: 1,volume: 22.28,volumeFormatted: 22.28,perTransactionFee: 0.05,perTransactionFeeFormatted: 0.05,transactionPercentage: 0.001,transactionPercentageFormatted: 0.1%,price: 0.07,priceFormatted: $22.28 @ 0.1%\n1 x $0.05,priceExtended: 0.07,priceExtendedFormatted: 0.07,lineItems: null},{id: SM3YFIDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: Fallback-MD,explanation: ,transactionCount: 3,volume: 276.63,volumeFormatted: 276.63,perTransactionFee: 0.081,perTransactionFeeFormatted: 0.081,transactionPercentage: 0.001,transactionPercentageFormatted: 0.1%,price: 0.52,priceFormatted: $276.63 @ 0.1%\n3 x $0.081,priceExtended: 0.52,priceExtendedFormatted: 0.52,lineItems: null},{id: SM4HREDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: Fallback-MB,explanation: ,transactionCount: 1,volume: 13.37,volumeFormatted: 13.37,perTransactionFee: 0.05,perTransactionFeeFormatted: 0.05,transactionPercentage: 0.001,transactionPercentageFormatted: 0.1%,price: 0.06,priceFormatted: $13.37 @ 0.1%\n1 x $0.05,priceExtended: 0.06,priceExtendedFormatted: 0.06,lineItems: null},{id: SM4SSKTU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: Swiped/EMV Enabled-VS,explanation: ,transactionCount: 2,volume: 21.92,volumeFormatted: 21.92,perTransactionFee: 0.05,perTransactionFeeFormatted: 0.05,transactionPercentage: 0.001,transactionPercentageFormatted: 0.1%,price: 0.12,priceFormatted: $21.92 @ 0.1%\n2 x $0.05,priceExtended: 0.12,priceExtendedFormatted: 0.12,lineItems: null},{id: SM4Z2EDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: Swiped/EMV Enabled-VD,explanation: ,transactionCount: 55,volume: 1448.3,volumeFormatted: 1,448.30,perTransactionFee: 0.081,perTransactionFeeFormatted: 0.081,transactionPercentage: 0.001,transactionPercentageFormatted: 0.1%,price: 5.9,priceFormatted: $1,448.30 @ 0.1%\n55 x $0.081,priceExtended: 5.9,priceExtendedFormatted: 5.90,lineItems: null},{id: SM5ADYTU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: Swiped/EMV Enabled-MC,explanation: ,transactionCount: 5,volume: 207.07,volumeFormatted: 207.07,perTransactionFee: 0.05,perTransactionFeeFormatted: 0.05,transactionPercentage: 0.001,transactionPercentageFormatted: 0.1%,price: 0.46,priceFormatted: $207.07 @ 0.1%\n5 x $0.05,priceExtended: 0.46,priceExtendedFormatted: 0.46,lineItems: null},{id: SM5K6UTU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: Swiped/EMV Enabled-MD,explanation: ,transactionCount: 45,volume: 1037.2,volumeFormatted: 1,037.20,perTransactionFee: 0.081,perTransactionFeeFormatted: 0.081,transactionPercentage: 0.001,transactionPercentageFormatted: 0.1%,price: 4.68,priceFormatted: $1,037.20 @ 0.1%\n45 x $0.081,priceExtended: 4.68,priceExtendedFormatted: 4.68,lineItems: null},{id: SM6FHBDU6MI65KNZTYA4RH54WI,lineType: count-and-volume,productId: ,quantity: 1,description: Swiped/EMV Enabled-AM,explanation: ,transactionCount: 1,volume: 27.85,volumeFormatted: 27.85,perTransactionFee: 0.1,perTransactionFeeFormatted: 0.10,transactionPercentage: 0.002,transactionPercentageFormatted: 0.2%,price: 0.16,priceFormatted: $27.85 @ 0.2%\n1 x $0.10,priceExtended: 0.16,priceExtendedFormatted: 0.16,lineItems: null},{id: SM6WSXTU6MI65KNZTYA4RH54WI,lineType: tx-count,productId: ,quantity: 1,description: Batch Fee,explanation: ,transactionCount: 30,volume: 0,volumeFormatted: 0.00,perTransactionFee: 0.08,perTransactionFeeFormatted: 0.08,transactionPercentage: 0,transactionPercentageFormatted: 0%,price: 2.4,priceFormatted: 30 x $0.08,priceExtended: 2.4,priceExtendedFormatted: 2.40,lineItems: null}},{id: SM7VV7DU6MI65KNZTYA4RH54WI,lineType: header,productId: ,quantity: 0,description: Misc Fees,explanation: These are uncommon and unusual fees that occassionally crop up.,transactionCount: 0,volume: 0,volumeFormatted: 0.00,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0,transactionPercentageFormatted: 0%,price: 0,priceFormatted: ,priceExtended: 10,priceExtendedFormatted: 10.00,lineItems: {id: SNAJQDTU6MI65KNZTYA4RH54WI,lineType: ,productId: ,quantity: 1,description: Monthly Fee,explanation: ,transactionCount: 1,volume: 0,volumeFormatted: 0.00,perTransactionFee: 0,perTransactionFeeFormatted: 0.00,transactionPercentage: 0,transactionPercentageFormatted: 0%,price: 10,priceFormatted: ,priceExtended: 10,priceExtendedFormatted: 10.00,lineItems: null}},payments: {id: SNAUJNTU6MI65KNZTYA4RH54WI,timestamp: 2023-10-27T18:06:58Z,transactionType: TSYS,paymentType: TSYS ACH,authCode: ,maskedPan: ****0000,pending: false,approved: true,responseDescription: SUBMITTED TO FED,amount: 8058.21,amountFormatted: 8,058.21},deposits: {id: SNBQZJTU6MI65KNZTYA4RH54WI,transactionCount: 230,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 10854.53,netDepositFormatted: 10,854.53,totalSales: 10854.53,totalSalesFormatted: 10,854.53,totalRefunds: 0,totalRefundsFormatted: 0.00},{id: SNCXKBDU6MI65KNZTYA4RH54WI,transactionCount: 328,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 18320.2,netDepositFormatted: 18,320.20,totalSales: 18320.2,totalSalesFormatted: 18,320.20,totalRefunds: 0,totalRefundsFormatted: 0.00},{id: SNB3JFDU6MI65KNZTYA4RH54WI,transactionCount: 599,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 29308.32,netDepositFormatted: 29,308.32,totalSales: 29308.32,totalSalesFormatted: 29,308.32,totalRefunds: 0,totalRefundsFormatted: 0.00},{id: SNDTOITU6MI65KNZTYA4RH54WI,transactionCount: 635,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 31839.34,netDepositFormatted: 31,839.34,totalSales: 31839.34,totalSalesFormatted: 31,839.34,totalRefunds: 0,totalRefundsFormatted: 0.00},{id: SNECGJTU6MI65KNZTYA4RH54WI,transactionCount: 19,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 449.25,netDepositFormatted: 449.25,totalSales: 449.25,totalSalesFormatted: 449.25,totalRefunds: 0,totalRefundsFormatted: 0.00},{id: SNE26DDU6MI65KNZTYA4RH54WI,transactionCount: 503,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 25812.21,netDepositFormatted: 25,812.21,totalSales: 25812.21,totalSalesFormatted: 25,812.21,totalRefunds: 0,totalRefundsFormatted: 0.00},{id: SNGYFUDU6MI65KNZTYA4RH54WI,transactionCount: 277,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 10753.31,netDepositFormatted: 10,753.31,totalSales: 10753.31,totalSalesFormatted: 10,753.31,totalRefunds: 0,totalRefundsFormatted: 0.00},{id: SNH656DU6MI65KNZTYA4RH54WI,transactionCount: 132,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 4264.1,netDepositFormatted: 4,264.10,totalSales: 4264.1,totalSalesFormatted: 4,264.10,totalRefunds: 0,totalRefundsFormatted: 0.00},{id: SNJD5OTU6MI65KNZTYA4RH54WI,transactionCount: 239,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 34091.34,netDepositFormatted: 34,091.34,totalSales: 34091.34,totalSalesFormatted: 34,091.34,totalRefunds: 0,totalRefundsFormatted: 0.00},{id: SNJ24WDU6MI65KNZTYA4RH54WI,transactionCount: 492,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 28462.69,netDepositFormatted: 28,462.69,totalSales: 28466.02,totalSalesFormatted: 28,466.02,totalRefunds: 3.33,totalRefundsFormatted: 3.33},{id: SNQ6TFTU6MI65KNZTYA4RH54WI,transactionCount: 238,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 10953.64,netDepositFormatted: 10,953.64,totalSales: 10953.64,totalSalesFormatted: 10,953.64,totalRefunds: 0,totalRefundsFormatted: 0.00},{id: SNRK3JDU6MI65KNZTYA4RH54WI,transactionCount: 583,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 29009.22,netDepositFormatted: 29,009.22,totalSales: 29009.22,totalSalesFormatted: 29,009.22,totalRefunds: 0,totalRefundsFormatted: 0.00},{id: SNRTVADU6MI65KNZTYA4RH54WI,transactionCount: 293,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 10220.47,netDepositFormatted: 10,220.47,totalSales: 10220.47,totalSalesFormatted: 10,220.47,totalRefunds: 0,totalRefundsFormatted: 0.00},{id: SNSE2HDU6MI65KNZTYA4RH54WI,transactionCount: 144,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 8442.06,netDepositFormatted: 8,442.06,totalSales: 8442.06,totalSalesFormatted: 8,442.06,totalRefunds: 0,totalRefundsFormatted: 0.00},{id: SOV4GBDU6MI65KNZTYA4RH54WI,transactionCount: 162,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 7534.13,netDepositFormatted: 7,534.13,totalSales: 7534.13,totalSalesFormatted: 7,534.13,totalRefunds: 0,totalRefundsFormatted: 0.00},{id: SOWZYODU6MI65KNZTYA4RH54WI,transactionCount: 224,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 10763.65,netDepositFormatted: 10,763.65,totalSales: 10773.69,totalSalesFormatted: 10,773.69,totalRefunds: 10.04,totalRefundsFormatted: 10.04},{id: SOXT77DU6MI65KNZTYA4RH54WI,transactionCount: 276,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 12528.69,netDepositFormatted: 12,528.69,totalSales: 12528.69,totalSalesFormatted: 12,528.69,totalRefunds: 0,totalRefundsFormatted: 0.00},{id: SOXGNLTU6MI65KNZTYA4RH54WI,transactionCount: 620,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 34943.14,netDepositFormatted: 34,943.14,totalSales: 34993.3,totalSalesFormatted: 34,993.30,totalRefunds: 50.16,totalRefundsFormatted: 50.16},{id: SOX5LXTU6MI65KNZTYA4RH54WI,transactionCount: 586,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 32064.72,netDepositFormatted: 32,064.72,totalSales: 32223.03,totalSalesFormatted: 32,223.03,totalRefunds: 158.31,totalRefundsFormatted: 158.31},{id: SOYNB5TU6MI65KNZTYA4RH54WI,transactionCount: 232,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 9773.48,netDepositFormatted: 9,773.48,totalSales: 9773.48,totalSalesFormatted: 9,773.48,totalRefunds: 0,totalRefundsFormatted: 0.00},{id: SOY7BKDU6MI65KNZTYA4RH54WI,transactionCount: 148,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 4369.79,netDepositFormatted: 4,369.79,totalSales: 4369.79,totalSalesFormatted: 4,369.79,totalRefunds: 0,totalRefundsFormatted: 0.00},{id: SOZOURDU6MI65KNZTYA4RH54WI,transactionCount: 157,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 7073.39,netDepositFormatted: 7,073.39,totalSales: 7073.39,totalSalesFormatted: 7,073.39,totalRefunds: 0,totalRefundsFormatted: 0.00},{id: SOZZADDU6MI65KNZTYA4RH54WI,transactionCount: 223,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 12427.9,netDepositFormatted: 12,427.90,totalSales: 12427.9,totalSalesFormatted: 12,427.90,totalRefunds: 0,totalRefundsFormatted: 0.00},{id: SO2LPBDU6MI65KNZTYA4RH54WI,transactionCount: 558,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 27126.43,netDepositFormatted: 27,126.43,totalSales: 27126.43,totalSalesFormatted: 27,126.43,totalRefunds: 0,totalRefundsFormatted: 0.00},{id: SO2326DU6MI65KNZTYA4RH54WI,transactionCount: 275,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 13371.34,netDepositFormatted: 13,371.34,totalSales: 13371.34,totalSalesFormatted: 13,371.34,totalRefunds: 0,totalRefundsFormatted: 0.00},{id: SO3K6ETU6MI65KNZTYA4RH54WI,transactionCount: 638,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 29393.37,netDepositFormatted: 29,393.37,totalSales: 29393.37,totalSalesFormatted: 29,393.37,totalRefunds: 0,totalRefundsFormatted: 0.00},{id: SO375CTU6MI65KNZTYA4RH54WI,transactionCount: 282,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 10895.79,netDepositFormatted: 10,895.79,totalSales: 10895.79,totalSalesFormatted: 10,895.79,totalRefunds: 0,totalRefundsFormatted: 0.00},{id: SO4UX6TU6MI65KNZTYA4RH54WI,transactionCount: 160,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 5154.05,netDepositFormatted: 5,154.05,totalSales: 5194.16,totalSalesFormatted: 5,194.16,totalRefunds: 40.11,totalRefundsFormatted: 40.11},{id: SO6OPYTU6MI65KNZTYA4RH54WI,transactionCount: 169,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 5940.67,netDepositFormatted: 5,940.67,totalSales: 6059.93,totalSalesFormatted: 6,059.93,totalRefunds: 119.26,totalRefundsFormatted: 119.26},{id: SO7LQQTU6MI65KNZTYA4RH54WI,transactionCount: 206,batchId: ,feesPaid: 0,feesPaidFormatted: 0.00,netDeposit: 10470.61,netDepositFormatted: 10,470.61,totalSales: 10470.61,totalSalesFormatted: 10,470.61,totalRefunds: 0,totalRefundsFormatted: 0.00}}/div>h3 idpartner-commission-breakdown-api-partner-commission-breakdown>Partner Commission Breakdown ( /api/partner-commission-breakdown )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/partner-commission-breakdown/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Partner/li>li>strong>Required Role:/strong> Partner API Access/li>/ul>p>This API allows partners to pull down the low level data used to compute a partner commission for a specific merchant statement./p>p>The code>statementId/code> is required and must be the id of a valid merchant invoice of type code>statement/code>./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/partner-commission-breakdown HTTP/1.1Host: api.blockchyp.comContent-Length: 54Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:4725705ce63983c1acd0a929d4bdc06530d02c46eb7a5f2b6cadd8319b23b38dNonce: c3c7be79ecd5e41a0dbe2327213c9e742d562375975fc31a63df97ab936b60b5Timestamp: 2021-05-20T13:39:51Z{ test: false, timeout: 120}Response:HTTP/1.1 200 OK{success: false,error: ,responseDescription: ,invoiceId: YXIYN627J7005FBWAJBKYEIAAQ,partnerName: Demo Partner, Inc.,partnerStatementId: SCH34K3JAEI65EJNAJBKYEIAAI,partnerStatementDate: 2023-09-30T04:28:21Z,merchantId: W5JCF4NVXAI6ZE6K700KYEIAAI,merchantCompanyName: Tacos Panjamo,merchantDbaName: Tacos Panjamo,grandTotal: 8058.21,grandTotalFormatted: 8,058.21,totalFees: 8058.21,totalFeesFormatted: 8,058.21,totalDue: 0,totalDueFormatted: 0.00,totalVolume: 486611.83,totalVolumeFormatted: 486,611.83,totalTransactions: 9628,partnerResidual: 332.88,partnerResidualFormatted: 332.88,interchange: 6175.64,interchangeFormatted: 6,175.64,assessments: 653.05,assessmentsFormatted: 653.05,totalPassthrough: 6828.69,totalPassthroughFormatted: 6,828.69,totalNonPassthrough: 215.83,totalNonPassthroughFormatted: 215.83,totalCardBrandFees: 7044.52,totalCardBrandFeesFormatted: 7,044.52,totalBuyRate: 7398.54,totalBuyRateFormatted: 7,398.54,buyRateBeforePassthrough: 569.85,buyRateBeforePassthroughFormatted: 569.85,netMarkup: 443.84,netMarkupFormatted: 443.84,partnerNonPassthroughShare: 161.87,partnerNonPassthroughShareFormatted: 161.87,chargebackFees: 0,chargebackFeesFormatted: 0.00,chargebackCount: 0,partnerPercentage: 0.75,partnerPercentageFormatted: 75%,buyRateLineItems: {description: Standard,volume: 180755.76,volumeFormatted: 180,755.76,volumeRate: 0.00015,volumeRateFormatted: 0.015%,count: 2485,countRate: 0.02,countRateFormatted: 0.02,rateSummary: 180,755.76 @ 0.015%, 2,485 X 0.02,total: 103.94,totalFormatted: 103.94},{description: Premium,volume: 19751.28,volumeFormatted: 19,751.28,volumeRate: 0.0012,volumeRateFormatted: 0.12%,count: 160,countRate: 0.07,countRateFormatted: 0.07,rateSummary: 19,751.28 @ 0.12%, 160 X 0.07,total: 58.62,totalFormatted: 58.62},{description: Debit,volume: 286486,volumeFormatted: 286,486.00,volumeRate: 0.00015,volumeRateFormatted: 0.015%,count: 6983,countRate: 0.045,countRateFormatted: 0.045,rateSummary: 286,486.00 @ 0.015%, 6,983 X 0.045,total: 400.19,totalFormatted: 400.19},{description: Batch Fees,volume: 0,volumeFormatted: ,volumeRate: 0,volumeRateFormatted: ,count: 30,countRate: 0.07,countRateFormatted: 0.07,rateSummary: 30 X 0.07,total: 2.1,totalFormatted: 2.10},{description: Monthly,volume: 0,volumeFormatted: ,volumeRate: 0,volumeRateFormatted: ,count: 1,countRate: 5,countRateFormatted: 5.00,rateSummary: 1 X 5.00,total: 5,totalFormatted: 5.00},revenueDetails: {id: ,description: Total Acquiring Revenue,expandable: false,negative: false,total: 8058.21,totalFormatted: 8,058.21,perTranFeeRange: null,transactionPercentageRange: null,detailLines: {id: ,description: WAB,expandable: false,negative: false,total: 8058.21,totalFormatted: 8,058.21,perTranFeeRange: null,transactionPercentageRange: null,detailLines: {id: ,description: BlockChyp Fees,expandable: false,negative: false,total: 2430.02,totalFormatted: 2,430.02,perTranFeeRange: null,transactionPercentageRange: null,detailLines: null},{id: ,description: Interchange Fees,expandable: false,negative: false,total: 12351.28,totalFormatted: 12,351.28,perTranFeeRange: null,transactionPercentageRange: null,detailLines: null},{id: ,description: Misc Fees,expandable: false,negative: false,total: 20,totalFormatted: 20.00,perTranFeeRange: null,transactionPercentageRange: null,detailLines: null},{id: ,description: Other Passthrough Fees,expandable: false,negative: false,total: 1315.12,totalFormatted: 1,315.12,perTranFeeRange: null,transactionPercentageRange: null,detailLines: null}}},cardBrandCostDetails: {id: ,description: Total Card Brand Costs,expandable: false,negative: false,total: 7044.52,totalFormatted: 7,044.52,perTranFeeRange: null,transactionPercentageRange: null,detailLines: {id: ,description: WAB,expandable: false,negative: false,total: 7044.52,totalFormatted: 7,044.52,perTranFeeRange: null,transactionPercentageRange: null,detailLines: {id: ,description: Passthrough Fees,expandable: false,negative: false,total: 6828.69,totalFormatted: 6,828.69,perTranFeeRange: null,transactionPercentageRange: null,detailLines: {id: ,description: Interchange Fees,expandable: false,negative: false,total: 6175.64,totalFormatted: 6,175.64,perTranFeeRange: null,transactionPercentageRange: null,detailLines: {id: ,description: DISC,expandable: false,negative: false,total: 462.86,totalFormatted: 462.86,perTranFeeRange: null,transactionPercentageRange: null,detailLines: {id: ,description: DS Commercial Electronic Submission Level,expandable: false,negative: false,total: 61.5,totalFormatted: 61.50,perTranFeeRange: {min: 0.15,avg: 0.15,max: 0.15},transactionPercentageRange: {min: 2.45%,avg: 2.45%,max: 2.45%},detailLines: null},{id: ,description: DS PSL - Retail Prepaid,expandable: false,negative: false,total: 1.25,totalFormatted: 1.25,perTranFeeRange: {min: 0.16,avg: 0.16,max: 0.16},transactionPercentageRange: {min: 1.12%,avg: 1.12%,max: 1.12%},detailLines: null},{id: ,description: DS PSL Retail DB,expandable: false,negative: false,total: 12.89,totalFormatted: 12.89,perTranFeeRange: {min: 0.16,avg: 0.16,max: 0.16},transactionPercentageRange: {min: 1.10%,avg: 1.10%,max: 1.10%},detailLines: null},{id: ,description: DS PSL Retail PR,expandable: false,negative: false,total: 180.69,totalFormatted: 180.69,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 1.74%,avg: 1.74%,max: 1.74%},detailLines: null},{id: ,description: DS PSL Retail Rewards,expandable: false,negative: false,total: 203.06,totalFormatted: 203.06,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 1.72%,avg: 1.72%,max: 1.72%},detailLines: null},{id: ,description: DS Retail (Premium Plus),expandable: false,negative: false,total: 3.4699999999999998,totalFormatted: 3.47,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 2.25%,avg: 2.25%,max: 2.25%},detailLines: null}},{id: ,description: AMEX,expandable: false,negative: false,total: 418.89,totalFormatted: 418.89,perTranFeeRange: null,transactionPercentageRange: null,detailLines: {id: ,description: AM Prepaid Tier 1,expandable: false,negative: false,total: 0.48,totalFormatted: 0.48,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 1.35%,avg: 1.35%,max: 1.35%},detailLines: null},{id: ,description: AM Retail Tier 1,expandable: false,negative: false,total: 66.31,totalFormatted: 66.31,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 1.60%,avg: 1.60%,max: 1.60%},detailLines: null},{id: ,description: AM Retail Tier 2,expandable: false,negative: false,total: 191.15,totalFormatted: 191.15,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 1.95%,avg: 1.95%,max: 1.95%},detailLines: null},{id: ,description: AM Retail Tier 3,expandable: false,negative: false,total: 160.95,totalFormatted: 160.95,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 2.40%,avg: 2.40%,max: 2.40%},detailLines: null}},{id: ,description: VISA,expandable: false,negative: false,total: 3398.71,totalFormatted: 3,398.71,perTranFeeRange: null,transactionPercentageRange: null,detailLines: {id: ,description: VS Business Card CP Debit,expandable: false,negative: false,total: 14.84,totalFormatted: 14.84,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 1.70%,avg: 1.70%,max: 1.70%},detailLines: null},{id: ,description: VS Business Purchase Retail Prepaid,expandable: false,negative: false,total: 10.41,totalFormatted: 10.41,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 2.15%,avg: 2.15%,max: 2.15%},detailLines: null},{id: ,description: VS Business Tr 5 Prod 2,expandable: false,negative: false,total: 130.08,totalFormatted: 130.08,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 2.25%,avg: 2.25%,max: 2.25%},detailLines: null},{id: ,description: VS Business Tr1 Prod 2,expandable: false,negative: false,total: 1.26,totalFormatted: 1.26,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 1.90%,avg: 1.90%,max: 1.90%},detailLines: null},{id: ,description: VS Business Tr2 Prod 2,expandable: false,negative: false,total: 56.54,totalFormatted: 56.54,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 2.05%,avg: 2.05%,max: 2.05%},detailLines: null},{id: ,description: VS Business Tr3 Prod 2,expandable: false,negative: false,total: 26.04,totalFormatted: 26.04,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 2.10%,avg: 2.10%,max: 2.10%},detailLines: null},{id: ,description: VS Business Tr4 Prod 2,expandable: false,negative: false,total: 50.54,totalFormatted: 50.54,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 2.20%,avg: 2.20%,max: 2.20%},detailLines: null},{id: ,description: VS CPS Retail Check Debit,expandable: false,negative: false,total: 192.9,totalFormatted: 192.90,perTranFeeRange: {min: 0.15,avg: 0.15,max: 0.15},transactionPercentageRange: {min: 0.80%,avg: 0.80%,max: 0.80%},detailLines: null},{id: ,description: VS CPS Retail Pp,expandable: false,negative: false,total: 81.9,totalFormatted: 81.90,perTranFeeRange: {min: 0.15,avg: 0.15,max: 0.15},transactionPercentageRange: {min: 1.15%,avg: 1.15%,max: 1.15%},detailLines: null},{id: ,description: VS CPS Small Ticket Debit,expandable: false,negative: false,total: 20.29,totalFormatted: 20.29,perTranFeeRange: {min: 0.04,avg: 0.04,max: 0.04},transactionPercentageRange: {min: 1.55%,avg: 1.55%,max: 1.55%},detailLines: null},{id: ,description: VS CPS Small Ticket Pp,expandable: false,negative: false,total: 11.3,totalFormatted: 11.30,perTranFeeRange: {min: 0.05,avg: 0.05,max: 0.05},transactionPercentageRange: {min: 1.60%,avg: 1.60%,max: 1.60%},detailLines: null},{id: ,description: VS CPS Small Ticket Regulated,expandable: false,negative: false,total: 158.76,totalFormatted: 158.76,perTranFeeRange: {min: 0.22,avg: 0.22,max: 0.22},transactionPercentageRange: {min: 0.05%,avg: 0.05%,max: 0.05%},detailLines: null},{id: ,description: VS Credit Voucher Non PT Credit,expandable: false,negative: false,total: -2.16,totalFormatted: -2.16,perTranFeeRange: {min: 0.00,avg: 0.00,max: 0.00},transactionPercentageRange: {min: 1.76%,avg: 1.76%,max: 1.76%},detailLines: null},{id: ,description: VS Electronic,expandable: false,negative: false,total: 1.6400000000000001,totalFormatted: 1.64,perTranFeeRange: {min: 0.00,avg: 0.00,max: 0.00},transactionPercentageRange: {min: 1.10%,avg: 1.10%,max: 1.10%},detailLines: null},{id: ,description: VS InterReg Corporate,expandable: false,negative: false,total: 1.34,totalFormatted: 1.34,perTranFeeRange: {min: 0.00,avg: 0.00,max: 0.00},transactionPercentageRange: {min: 2%,avg: 2%,max: 2%},detailLines: null},{id: ,description: VS InterReg Regulated Debit,expandable: false,negative: false,total: 0.23,totalFormatted: 0.23,perTranFeeRange: {min: 0.22,avg: 0.22,max: 0.22},transactionPercentageRange: {min: 0.05%,avg: 0.05%,max: 0.05%},detailLines: null},{id: ,description: VS InterReg Super Premium,expandable: false,negative: false,total: 0.4,totalFormatted: 0.40,perTranFeeRange: {min: 0.00,avg: 0.00,max: 0.00},transactionPercentageRange: {min: 1.97%,avg: 1.97%,max: 1.97%},detailLines: null},{id: ,description: VS Premium Card,expandable: false,negative: false,total: 2.13,totalFormatted: 2.13,perTranFeeRange: {min: 0.00,avg: 0.00,max: 0.00},transactionPercentageRange: {min: 1.80%,avg: 1.80%,max: 1.80%},detailLines: null},{id: ,description: VS US Corporate Card - Card Present,expandable: false,negative: false,total: 2.41,totalFormatted: 2.41,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 2.50%,avg: 2.50%,max: 2.50%},detailLines: null},{id: ,description: VS US Purchasing Card - Card Present,expandable: false,negative: false,total: 2.9,totalFormatted: 2.90,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 2.50%,avg: 2.50%,max: 2.50%},detailLines: null},{id: ,description: VS US Regulated Debit,expandable: false,negative: false,total: 794.27,totalFormatted: 794.27,perTranFeeRange: {min: 0.22,avg: 0.22,max: 0.22},transactionPercentageRange: {min: 0.05%,avg: 0.05%,max: 0.05%},detailLines: null},{id: ,description: VS VIN Product 2,expandable: false,negative: false,total: 460.15,totalFormatted: 460.15,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 1.65%,avg: 1.65%,max: 1.65%},detailLines: null},{id: ,description: VS VSP VIQ Product 2,expandable: false,negative: false,total: 1108,totalFormatted: 1,108.00,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 2.10%,avg: 2.10%,max: 2.10%},detailLines: null},{id: ,description: VS VT Product 2,expandable: false,negative: false,total: 125.74,totalFormatted: 125.74,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 1.51%,avg: 1.51%,max: 1.51%},detailLines: null},{id: ,description: VS VTR Product 2,expandable: false,negative: false,total: 103.82,totalFormatted: 103.82,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 1.65%,avg: 1.65%,max: 1.65%},detailLines: null},{id: ,description: Visa VIQ Product 2,expandable: false,negative: false,total: 42.98,totalFormatted: 42.98,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 2.10%,avg: 2.10%,max: 2.10%},detailLines: null}},{id: ,description: MC,expandable: false,negative: false,total: 1895.18,totalFormatted: 1,895.18,perTranFeeRange: null,transactionPercentageRange: null,detailLines: {id: ,description: MC Business Level 1 Data Rate I,expandable: false,negative: false,total: 1.31,totalFormatted: 1.31,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 2.65%,avg: 2.65%,max: 2.65%},detailLines: null},{id: ,description: MC Business Level 2 Data Rate I,expandable: false,negative: false,total: 14.96,totalFormatted: 14.96,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 2.80%,avg: 2.80%,max: 2.80%},detailLines: null},{id: ,description: MC Business Level 3 Data Rate I,expandable: false,negative: false,total: 8.39,totalFormatted: 8.39,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 2.85%,avg: 2.85%,max: 2.85%},detailLines: null},{id: ,description: MC Business Level 4 Data Rate I,expandable: false,negative: false,total: 1.09,totalFormatted: 1.09,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 2.95%,avg: 2.95%,max: 2.95%},detailLines: null},{id: ,description: MC Business Level 5 Data Rate I,expandable: false,negative: false,total: 2.5300000000000002,totalFormatted: 2.53,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 3%,avg: 3%,max: 3%},detailLines: null},{id: ,description: MC Commercial Rate 1 Large Market,expandable: false,negative: false,total: 35.29,totalFormatted: 35.29,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 2.70%,avg: 2.70%,max: 2.70%},detailLines: null},{id: ,description: MC Consumer Credit Refund Group 4,expandable: false,negative: false,total: -0.88,totalFormatted: -0.88,perTranFeeRange: {min: 0.00,avg: 0.00,max: 0.00},transactionPercentageRange: {min: 1.75%,avg: 1.75%,max: 1.75%},detailLines: null},{id: ,description: MC Consumer Rate 2-Card Present Core,expandable: false,negative: false,total: 4.52,totalFormatted: 4.52,perTranFeeRange: {min: 0.00,avg: 0.00,max: 0.00},transactionPercentageRange: {min: 1.10%,avg: 1.10%,max: 1.10%},detailLines: null},{id: ,description: MC Corporate Data Rate 1,expandable: false,negative: false,total: 21.32,totalFormatted: 21.32,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 2.65%,avg: 2.65%,max: 2.65%},detailLines: null},{id: ,description: MC Enhanced Merit III Base,expandable: false,negative: false,total: 177.26,totalFormatted: 177.26,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 1.80%,avg: 1.80%,max: 1.80%},detailLines: null},{id: ,description: MC High Value Merit III Base 1,expandable: false,negative: false,total: 134.42,totalFormatted: 134.42,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 2.30%,avg: 2.30%,max: 2.30%},detailLines: null},{id: ,description: MC Merit 3 Prepaid,expandable: false,negative: false,total: 21.75,totalFormatted: 21.75,perTranFeeRange: {min: 0.15,avg: 0.15,max: 0.15},transactionPercentageRange: {min: 1.15%,avg: 1.15%,max: 1.15%},detailLines: null},{id: ,description: MC Merit III Credit,expandable: false,negative: false,total: 52.81,totalFormatted: 52.81,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 1.65%,avg: 1.65%,max: 1.65%},detailLines: null},{id: ,description: MC Merit III Debit,expandable: false,negative: false,total: 116.64,totalFormatted: 116.64,perTranFeeRange: {min: 0.15,avg: 0.15,max: 0.15},transactionPercentageRange: {min: 1.05%,avg: 1.05%,max: 1.05%},detailLines: null},{id: ,description: MC Small Ticket Card Present,expandable: false,negative: false,total: 0.24,totalFormatted: 0.24,perTranFeeRange: {min: 0.02,avg: 0.02,max: 0.02},transactionPercentageRange: {min: 1.65%,avg: 1.65%,max: 1.65%},detailLines: null},{id: ,description: MC US Cons Regulated POS Debit w/Fraud Adj,expandable: false,negative: false,total: 468.18,totalFormatted: 468.18,perTranFeeRange: {min: 0.22,avg: 0.22,max: 0.22},transactionPercentageRange: {min: 0.05%,avg: 0.05%,max: 0.05%},detailLines: null},{id: ,description: MC World Elite Merit III,expandable: false,negative: false,total: 666,totalFormatted: 666.00,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 2.30%,avg: 2.30%,max: 2.30%},detailLines: null},{id: ,description: MC World Elite Small Ticket Card Present,expandable: false,negative: false,total: 0.84,totalFormatted: 0.84,perTranFeeRange: {min: 0.02,avg: 0.02,max: 0.02},transactionPercentageRange: {min: 2.30%,avg: 2.30%,max: 2.30%},detailLines: null},{id: ,description: MC World Merit III,expandable: false,negative: false,total: 168.41,totalFormatted: 168.41,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 1.90%,avg: 1.90%,max: 1.90%},detailLines: null},{id: ,description: MC World Small Ticket Card Present,expandable: false,negative: false,total: 0.1,totalFormatted: 0.10,perTranFeeRange: {min: 0.02,avg: 0.02,max: 0.02},transactionPercentageRange: {min: 1.90%,avg: 1.90%,max: 1.90%},detailLines: null}}},{id: ,description: Assessment Fees,expandable: false,negative: false,total: 653.05,totalFormatted: 653.05,perTranFeeRange: null,transactionPercentageRange: null,detailLines: {id: ,description: MC,expandable: false,negative: false,total: 184.34,totalFormatted: 184.34,perTranFeeRange: null,transactionPercentageRange: null,detailLines: {id: ,description: ACQ Brand Volume,expandable: false,negative: false,total: 171.88,totalFormatted: 171.88,perTranFeeRange: {min: 0.00,avg: 0.00,max: 0.00},transactionPercentageRange: {min: 0.13%,avg: 0.13%,max: 0.13%},detailLines: null},{id: ,description: ACQ Brand Volume Above,expandable: false,negative: false,total: 12.46,totalFormatted: 12.46,perTranFeeRange: {min: 0.00,avg: 0.00,max: 0.00},transactionPercentageRange: {min: 0.14%,avg: 0.14%,max: 0.14%},detailLines: null}},{id: ,description: VISA,expandable: false,negative: false,total: 402.25,totalFormatted: 402.25,perTranFeeRange: null,transactionPercentageRange: null,detailLines: {id: ,description: US Acquirer Service Fee - Credit,expandable: false,negative: false,total: 142.96,totalFormatted: 142.96,perTranFeeRange: {min: 0.00,avg: 0.00,max: 0.00},transactionPercentageRange: {min: 0.14%,avg: 0.14%,max: 0.14%},detailLines: null},{id: ,description: US Acquirer Service Fee - Debit,expandable: false,negative: false,total: 259.29,totalFormatted: 259.29,perTranFeeRange: {min: 0.00,avg: 0.00,max: 0.00},transactionPercentageRange: {min: 0.13%,avg: 0.13%,max: 0.13%},detailLines: null}},{id: ,description: AMEX,expandable: false,negative: false,total: 32.6,totalFormatted: 32.60,perTranFeeRange: null,transactionPercentageRange: null,detailLines: {id: ,description: US Assessment Fee,expandable: false,negative: false,total: 32.6,totalFormatted: 32.60,perTranFeeRange: {min: 0.00,avg: 0.00,max: 0.00},transactionPercentageRange: {min: 0.17%,avg: 0.17%,max: 0.17%},detailLines: null}},{id: ,description: DISC,expandable: false,negative: false,total: 33.86,totalFormatted: 33.86,perTranFeeRange: null,transactionPercentageRange: null,detailLines: {id: ,description: Discover Acquirer Assessment Fee,expandable: false,negative: false,total: 33.86,totalFormatted: 33.86,perTranFeeRange: {min: 0.00,avg: 0.00,max: 0.00},transactionPercentageRange: {min: 0.14%,avg: 0.14%,max: 0.14%},detailLines: null}}}},{id: ,description: Non Passthrough Fees,expandable: false,negative: false,total: 215.83,totalFormatted: 215.83,perTranFeeRange: null,transactionPercentageRange: null,detailLines: {id: ,description: VISA,expandable: false,negative: false,total: 119.67,totalFormatted: 119.67,perTranFeeRange: null,transactionPercentageRange: null,detailLines: {id: ,description: International ACQ - IAF,expandable: false,negative: false,total: 2.05,totalFormatted: 2.05,perTranFeeRange: {min: 0.00,avg: 0.00,max: 0.00},transactionPercentageRange: {min: 0.45%,avg: 0.45%,max: 0.45%},detailLines: null},{id: ,description: NAPF DOM Credit Auth,expandable: false,negative: false,total: 27.4,totalFormatted: 27.40,perTranFeeRange: {min: 0.0195,avg: 0.0195,max: 0.0195},transactionPercentageRange: {min: 0%,avg: 0%,max: 0%},detailLines: null},{id: ,description: NAPF DOM Credit Auth Reversal,expandable: false,negative: false,total: 0.02,totalFormatted: 0.02,perTranFeeRange: {min: 0.0195,avg: 0.0195,max: 0.0195},transactionPercentageRange: {min: 0%,avg: 0%,max: 0%},detailLines: null},{id: ,description: NAPF DOM Debit Auth,expandable: false,negative: false,total: 71.67,totalFormatted: 71.67,perTranFeeRange: {min: 0.0155,avg: 0.0155,max: 0.0155},transactionPercentageRange: {min: 0%,avg: 0%,max: 0%},detailLines: null},{id: ,description: NAPF DOM Debit Auth Reversal,expandable: false,negative: false,total: 0.11,totalFormatted: 0.11,perTranFeeRange: {min: 0.0155,avg: 0.0155,max: 0.0155},transactionPercentageRange: {min: 0%,avg: 0%,max: 0%},detailLines: null},{id: ,description: NAPF INTL Credit Auth,expandable: false,negative: false,total: 0.12,totalFormatted: 0.12,perTranFeeRange: {min: 0.0395,avg: 0.0395,max: 0.0395},transactionPercentageRange: {min: 0%,avg: 0%,max: 0%},detailLines: null},{id: ,description: NAPF INTL Debit Auth,expandable: false,negative: false,total: 0.36,totalFormatted: 0.36,perTranFeeRange: {min: 0.0355,avg: 0.0355,max: 0.0355},transactionPercentageRange: {min: 0%,avg: 0%,max: 0%},detailLines: null},{id: ,description: US Acquirer ISA Base Purchase,expandable: false,negative: false,total: 4.53,totalFormatted: 4.53,perTranFeeRange: {min: 0.00,avg: 0.00,max: 0.00},transactionPercentageRange: {min: 1%,avg: 1%,max: 1%},detailLines: null},{id: ,description: VS FANF CP,expandable: false,negative: false,total: 2,totalFormatted: 2.00,perTranFeeRange: {min: 0.00,avg: 0.00,max: 0.00},transactionPercentageRange: {min: 0%,avg: 0%,max: 0%},detailLines: null},{id: ,description: VS RAF Never Approve Domestic,expandable: false,negative: false,total: 0.3,totalFormatted: 0.30,perTranFeeRange: {min: 0.10,avg: 0.10,max: 0.10},transactionPercentageRange: {min: 0%,avg: 0%,max: 0%},detailLines: null},{id: ,description: Visa Acquirer Credit Voucher Fee Credit,expandable: false,negative: false,total: 0.02,totalFormatted: 0.02,perTranFeeRange: {min: 0.0195,avg: 0.0195,max: 0.0195},transactionPercentageRange: {min: 0%,avg: 0%,max: 0%},detailLines: null},{id: ,description: Visa Acquirer Credit Voucher Fee Debit/PPD,expandable: false,negative: false,total: 0.09,totalFormatted: 0.09,perTranFeeRange: {min: 0.0155,avg: 0.0155,max: 0.0155},transactionPercentageRange: {min: 0%,avg: 0%,max: 0%},detailLines: null},{id: ,description: Visa BASE II Transmission Fee,expandable: false,negative: false,total: 11,totalFormatted: 11.00,perTranFeeRange: {min: 0.0018,avg: 0.0018,max: 0.0018},transactionPercentageRange: {min: 0%,avg: 0%,max: 0%},detailLines: null}},{id: ,description: MC,expandable: false,negative: false,total: 86.65,totalFormatted: 86.65,perTranFeeRange: null,transactionPercentageRange: null,detailLines: {id: ,description: ACQ Program Support,expandable: false,negative: false,total: 3.48,totalFormatted: 3.48,perTranFeeRange: {min: 0.00,avg: 0.00,max: 0.00},transactionPercentageRange: {min: 0.85%,avg: 0.85%,max: 0.85%},detailLines: null},{id: ,description: Cross Border - Domestic,expandable: false,negative: false,total: 2.46,totalFormatted: 2.46,perTranFeeRange: {min: 0.00,avg: 0.00,max: 0.00},transactionPercentageRange: {min: 0.60%,avg: 0.60%,max: 0.60%},detailLines: null},{id: ,description: MC Acquirer License Fee,expandable: false,negative: false,total: 17.66,totalFormatted: 17.66,perTranFeeRange: {min: 0.00,avg: 0.00,max: 0.00},transactionPercentageRange: {min: 0.01%,avg: 0.01%,max: 0.01%},detailLines: null},{id: ,description: MC Safety Net Acquirer Fee,expandable: false,negative: false,total: 2.15,totalFormatted: 2.15,perTranFeeRange: {min: 0.0007,avg: 0.0007,max: 0.0007},transactionPercentageRange: {min: 0%,avg: 0%,max: 0%},detailLines: null},{id: ,description: Mastercard Location Fee,expandable: false,negative: false,total: 1.25,totalFormatted: 1.25,perTranFeeRange: {min: 0.00,avg: 0.00,max: 0.00},transactionPercentageRange: {min: 0%,avg: 0%,max: 0%},detailLines: null},{id: ,description: NABU Auth,expandable: false,negative: false,total: 59.61,totalFormatted: 59.61,perTranFeeRange: {min: 0.0195,avg: 0.0195,max: 0.0195},transactionPercentageRange: {min: 0%,avg: 0%,max: 0%},detailLines: null},{id: ,description: NABU Returns,expandable: false,negative: false,total: 0.04,totalFormatted: 0.04,perTranFeeRange: {min: 0.0195,avg: 0.0195,max: 0.0195},transactionPercentageRange: {min: 0%,avg: 0%,max: 0%},detailLines: null}},{id: ,description: DISC,expandable: false,negative: false,total: 6.31,totalFormatted: 6.31,perTranFeeRange: null,transactionPercentageRange: null,detailLines: {id: ,description: DS Network Authorization Fee,expandable: false,negative: false,total: 5.57,totalFormatted: 5.57,perTranFeeRange: {min: 0.019,avg: 0.019,max: 0.019},transactionPercentageRange: {min: 0%,avg: 0%,max: 0%},detailLines: null},{id: ,description: Discover Data Usage Fee,expandable: false,negative: false,total: 0.74,totalFormatted: 0.74,perTranFeeRange: {min: 0.0025,avg: 0.0025,max: 0.0025},transactionPercentageRange: {min: 0%,avg: 0%,max: 0%},detailLines: null}},{id: ,description: AMEX,expandable: false,negative: false,total: 3.2,totalFormatted: 3.20,perTranFeeRange: null,transactionPercentageRange: null,detailLines: {id: ,description: Amex Acquirer Transaction Fee,expandable: false,negative: false,total: 3.2,totalFormatted: 3.20,perTranFeeRange: {min: 0.02,avg: 0.02,max: 0.02},transactionPercentageRange: {min: 0%,avg: 0%,max: 0%},detailLines: null}}},{id: ,description: Ignored Costs,expandable: false,negative: false,total: 0,totalFormatted: 0.00,perTranFeeRange: null,transactionPercentageRange: null,detailLines: null}}}}/div>h3 idmerchant-profile-api-public-merchant-profile>Merchant Profile ( /api/public-merchant-profile )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/public-merchant-profile/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>The API returns detailed metadata about the merchant's configuration, includingbasic identity information, terminal settings, store and forward settings,and bank account information for merchants that support split settlement./p>p>Some of these fields can be updated via the Update Merchant API, but many of thesefields are controlled by underwriting and cannot be altered outside of the underwriting and risk processes./p>p>strong>Merchant Descriptive Fields/strong>/p>p>The following fields are basic descriptive fields that can be used to describe and identify merchants./p>ul>li>strong>companyName:/strong> The merchant's official corporate entity name./li>li>strong>dbaName:/strong> The business's DBA (doing business as) name./li>li>strong>contactName:/strong> Name of the merchant's primary control contact./li>li>strong>contactNumber:/strong> Primary control contact's phone number./li>li>strong>locationName:/strong> Optional location name for multi-location operators./li>li>strong>storeNumber:/strong> Optional store number for multi-location operators./li>li>strong>partnerRef:/strong> Optional reference number partners can add to a merchant record. Usually the partner's own identifier for the merchant./li>li>strong>timeZone:/strong> Unix style local time zone for the merchant. Example: America/New_York./li>li>strong>publicKey:/strong> Read only field. The merchant's blockchain public key. Generated and assigned when a merchant account is first created./li>li>strong>billingAddress:/strong> Address for billing and written correspondence./li>li>strong>shippingAddress:/strong> Physical shipping address. Usually the actual street address of the business./li>li>strong>status:/strong> Current status of the merchant account./li>li>strong>tcDisabled:/strong> Disables all terms and conditions features in the merchant dashboard. Used to hide the feature if a partner has not chosen to support it./li>li>strong>gatewayOnly:/strong> Indicates that a merchant has been boarded in gateway only mode. Not common./li>/ul>p>strong>Batch and Terminal Settings/strong>/p>p>The following fields are used to control batch closure and high level terminal configuration./p>ul>li>strong>batchCloseTime:/strong> Time in 24 hour HH:MM format when batches will automatically close in the merchant's local time. Defaults to 3 AM./li>li>strong>autoBatchClose:/strong> Flag the determines whether or not batches will automatically close. Defaults to true./li>li>strong>disableBatchEmails:/strong> Flag that optionally turns off automatic batch closure notification emails./li>li>strong>cooldownTimeout:/strong> The amount of time in seconds after a transactions for which the transaction response is displayed on the terminal. After the cooldown period elapses, the terminal will revert to the idle state and display the currently active terminal branding./li>li>strong>surveyTimeout:/strong> The amount of time in seconds a survey question should be displayed on a terminal before reverting to the idle screen./li>li>strong>pinEnabled:/strong> Enables pin code entry for debit cards, EBT cards, and EMV cards with pin CVMs. Will be ignored if terminals are not injected with the proper encryption keys./li>li>strong>pinBypassEnabled:/strong> Enable pin bypass for debit transactions./li>li>strong>cashBackEnabled:/strong> Enables cash back for debit transactions./li>li>strong>cashbackPresets:/strong> An array of four default values for cashback amounts when cashback is enabled./li>li>strong>storeAndForwardEnabled:/strong> Enables automatic store and forward during network outages. Store and Forward does not support cash back, refunds, EBT, or gift card transactions./li>li>strong>storeAndForwardFloorLimit:/strong> Maximum dollar value of a store and forward transaction./li>li>strong>ebtEnabled:/strong> Enables EBT (SNAP) on BlockChyp terminals./li>li>strong>tipEnabled:/strong> Enables tips entry on the terminal./li>li>strong>promptForTip:/strong> If true, the terminal will always prompt for a tip, even if the API call does not request a tip prompt./li>li>strong>tipDefaults:/strong> An array of exactly three percentages that will be used to calculate default tip amounts./li>li>strong>giftCardsDisabled:/strong> Disables BlockChyp gift cards. Normally only used if the merchant is using an alternate gift card system./li>li>strong>digitalSignaturesEnabled:/strong> Enables electronic signature capture for mag stripe cards and EMV cards with Signature CVMs./li>li>strong>digitalSignatureReversal:/strong> Will cause a transaction to auto-reverse if the consumer refuses to provide a signature./li>li>strong>manualEntryEnabled:/strong> Enables manual card entry./li>li>strong>manualEntryPromptZip:/strong> Requires zip code based address verification for manual card entry./li>li>strong>manualEntryPromptStreetNumber:/strong> Requires street/address based verification for manual card entry./li>/ul>p>strong>Card Brand and Transaction Settings/strong>/p>ul>li>strong>freeRangeRefundsEnabled:/strong> Enables direct refunds that do not reference a previous transaction./li>li>strong>partialAuthEnabled:/strong> Indicates that partial authorizations (usually for gift card support) are enabled./li>li>strong>splitBankAccountsEnabled:/strong> Used for law firm merchants only./li>li>strong>contactlessEmv:/strong> Enables contactless/tap transactions on a terminal. Defaults to true./li>li>strong>visa:/strong> Enables Visa transactions./li>li>strong>masterCard:/strong> Enables MasterCard transactions./li>li>strong>amex:/strong> Enables American Express transactions./li>li>strong>discover:/strong> Enables Discover transactions./li>li>strong>jcb:/strong> Enables JCB (Japan Card Bureau) transactions./li>li>strong>unionPay:/strong> Enables China UnionPay transactions./li>/ul>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/public-merchant-profile HTTP/1.1Host: api.blockchyp.comContent-Length: 54Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:4725705ce63983c1acd0a929d4bdc06530d02c46eb7a5f2b6cadd8319b23b38dNonce: c3c7be79ecd5e41a0dbe2327213c9e742d562375975fc31a63df97ab936b60b5Timestamp: 2021-05-20T13:39:51Z{ test: false, timeout: 120}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: , test: true, merchantId: 4QZ2I4QYIMI6TPHVAJBKYEIAA4, companyName: CLI Regression Test, locationName: , storeNumber: , timeZone: America/Los_Angeles, batchCloseTime: 04:00, terminalUpdateTime: 04:00, autoBatchClose: true, pinEnabled: true, cashBackEnabled: false, storeAndForwardEnabled: true, partialAuthEnabled: true, splitBankAccountsEnabled: false, storeAndForwardFloorLimit: 50.00, publicKey: 13F5JxEfZoM5aPF4Zdhwnh5Mazd6TyZjwhBLmR3F7sVYaCiDS9V, status: active}/div>h3 idlist-queued-transactions-api-queue-list>List Queued Transactions ( /api/queue/list )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/queue/list/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>Returns a list of transaction refs of transactions queued on a terminal.Details about the transactions can be retrieved using the Transaction StatusAPI./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:GET /api/queue/list HTTP/1.1Host: test.blockchyp.comContent-Length: 36Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:a8da5aa7ba6518b2ec392b3f7a221c5357b00163e0845bfbd769d161aa3c1effNonce: 3f915730b23a513342f667a4725e67fa373666e9341afec47e3c7fcb7ab5224dTimestamp: 2021-05-20T17:56:00Z{ terminalName: Test Terminal,}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: , transactionRefs: a, b, c, , }/div>h3 iddelete-queued-transaction-api-queue-delete>Delete Queued Transaction ( /api/queue/delete )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/queue/delete/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>Deletes one or all queued transactions from a terminal. If code>*/code> is passed asa transaction ref, then the entire terminal queue will be cleared. An error isreturned if the passed transaction ref is not queued on the terminal./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/queue/delete HTTP/1.1Host: test.blockchyp.comContent-Length: 105Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:a8da5aa7ba6518b2ec392b3f7a221c5357b00163e0845bfbd769d161aa3c1effNonce: 3f915730b23a513342f667a4725e67fa373666e9341afec47e3c7fcb7ab5224dTimestamp: 2021-05-20T17:56:00Z{ terminalName: Test Terminal, transactionRef: *,}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: ,}/div>h3 iddelete-customer-api-customer>Delete Customer ( /api/customer/CUSTOMER_ID> )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>DELETE/td>td>/api/customer/CUSTOMER_ID>/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API deletes a customer record./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:DELETE /api/customer/ID> HTTP/1.1Host: test.blockchyp.comContent-Length: 0Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:a8da5aa7ba6518b2ec392b3f7a221c5357b00163e0845bfbd769d161aa3c1effNonce: 3f915730b23a513342f667a4725e67fa373666e9341afec47e3c7fcb7ab5224dTimestamp: 2021-05-20T17:56:00ZResponse:HTTP/1.1 200 OK{ success: true, error: , responseDescription: ,}/div>h3 idtoken-metadata-api-token>Token Metadata ( /api/token/TOKEN> )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>GET/td>td>/api/token/TOKEN>/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API retrieves status and metadata information about a token, including any links to customer records. /p>p>This will also return any customer records related to the cardbehind the token. If the underlying card has been tokenizedmultiple times, all customers related to the card will be returned,even if those customer associations are related to other tokens./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:GET /api/token/TOKEN> HTTP/1.1Host: test.blockchyp.comAuthorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:a8da5aa7ba6518b2ec392b3f7a221c5357b00163e0845bfbd769d161aa3c1effNonce: 3f915730b23a513342f667a4725e67fa373666e9341afec47e3c7fcb7ab5224dTimestamp: 2021-05-20T17:56:00ZResponse:HTTP/1.1 200 OK{ success: true, error: , responseDescription: , token: { token: N2DTGDSSZNBAX7GT5HBZPHIOWA, maskedPan: ************4111, expiryMonth: 12, expiryYear: 12, paymentType: MC, customers: { id: XK4LRURF6II6ZB7UVTPEQAAREI, customerRef: , firstName: Peter, lastName: Gregory, companyName: Raviga Capital, emailAddress: , smsNumber: , paymentMethods: null }, { id: XK4LRXBF6II6ZB7WVTPEQAAREI, customerRef: , firstName: Laurie, lastName: Bream, companyName: Bream Hall, emailAddress: , smsNumber: , paymentMethods: null } }}/div>h3 idlink-token-api-link-token>Link Token ( /api/link-token )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/link-token/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API links a payment token with a customer record. Usually this would only be neededto reverse a previous unlink operation./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/link-token HTTP/1.1Host: test.blockchyp.comAuthorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:a8da5aa7ba6518b2ec392b3f7a221c5357b00163e0845bfbd769d161aa3c1effNonce: 3f915730b23a513342f667a4725e67fa373666e9341afec47e3c7fcb7ab5224dTimestamp: 2021-05-20T17:56:00Z{ test: true, timeout: 120, token: KJ3DPFELBAI6VOTRNSLM7WZLHE, customerId: KJ3DPFELBAI6VOTRNSLM7WZLSKT}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: ,}/div>h3 idunlink-token-api-unlink-token>Unlink Token ( /api/unlink-token )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/unlink-token/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API removes a payment token link from a customer record./p>p>This will remove links between the customer record and all tokensfor the same underlying card./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:GET /api/unlink-token HTTP/1.1Host: test.blockchyp.comAuthorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:a8da5aa7ba6518b2ec392b3f7a221c5357b00163e0845bfbd769d161aa3c1effNonce: 3f915730b23a513342f667a4725e67fa373666e9341afec47e3c7fcb7ab5224dTimestamp: 2021-05-20T17:56:00Z{ test: true, timeout: 120, token: KJ3DPFELBAI6VOTRNSLM7WZLHE, customerId: KJ3DPFELBAI6VOTRNSLM7WZLSKT}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: ,}/div>h3 idupdate-token-api-token>Update Token ( /api/token/TOKEN> )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/token/TOKEN>/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API updates a payment token in the gateway. This can be used to update token metadata such as expiration dates, cardholder name, bank name, account holder type, account type, address, and postal code./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/token/TOKEN> HTTP/1.1Host: test.blockchyp.comContent-Type: application/jsonAuthorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:a8da5aa7ba6518b2ec392b3f7a221c5357b00163e0845bfbd769d161aa3c1effNonce: 3f915730b23a513342f667a4725e67fa373666e9341afec47e3c7fcb7ab5224dTimestamp: 2021-05-20T17:56:00Z{ expiryMonth: 12, expiryYear: 2040}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: , token: { token: VLBZHCBOKJC3OZRCLLVBOFR4RM, maskedPan: ************5454, expiryMonth: 12, expiryYear: 2040, paymentType: VISA, cardholderName: Test/Card 05 }}/div>h3 iddelete-token-api-token>Delete Token ( /api/token/TOKEN> )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>DELETE/td>td>/api/token/TOKEN>/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API deletes a payment token from the gateway. Tokens are automatically deleted if they have not been usedfor a year./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:DELETE /api/token/TOKEN> HTTP/1.1Host: test.blockchyp.comContent-Length: 0Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:a8da5aa7ba6518b2ec392b3f7a221c5357b00163e0845bfbd769d161aa3c1effNonce: 3f915730b23a513342f667a4725e67fa373666e9341afec47e3c7fcb7ab5224dTimestamp: 2021-05-20T17:56:00ZResponse:HTTP/1.1 200 OK{ success: true, error: , responseDescription: ,}/div>h3 idreboot-terminal-api-terminal-reboot>Reboot Terminal ( /api/terminal-reboot )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/terminal-reboot/td>/tr>/tbody>/table>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API reboots the terminal./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/terminal-reboot HTTP/1.1Host: test.blockchyp.comContent-Length: 86Authorization: Dual ZKINZJ6QQPXTTP5LY75EDJNDPE:B2D6UBIJ4JFHDGYOHWIUSJ5XAE:14db4e7bf0513cfe90835f6c8e616279a2d683296f9a118a368c0c3d5a694cddNonce: 419033f763749cb13f675a79d10845c6617b58ea52e1fd54aa9362dc40465058Timestamp: 2021-05-20T17:39:22Z{ test: true, timeout: 120, terminalName: Test Terminal}Response:HTTP/1.1 200 OK{ success:true, errorMessage:}/div>h2 idterminal-api-2>Terminal API/h2>p>Every BlockChyp terminal has a small web server running a simple REST API. Developers can use this API to capture card present payments and activate gift cards. All other transactions are done directly through the Gateway API./p>h3 idterminal-activation>Terminal Activation/h3>p>A terminal must be activated and paired with a merchant account before it will accept transactions. To activate a terminal, login to the BlockChyp dashboard, create a test merchant account, and click strong>ACTIVATE TERMINAL/strong>./p>p>Next, connect your terminal to the network and power it up. Once the terminal starts up, it will display a message reading strong>TOUCH TO ACTIVATE/strong>. Touch the screen and in a few moments the terminal will display a six character activation code. Enter the code in the Dashboard's activation form along with a unique name you'd like to use for the terminal./p>p>The terminal will now be ready for transactions./p>h3 idweb-server-ports>Web Server Ports/h3>p>BlockChyp terminals listen for transactions on ports 8080 and 8443./p>ul>li>HTTP Port: 8080/li>li>HTTPS Port: 8443/li>/ul>p>Because terminals usually run on private networks and SSL can be difficult to implement on these networks, plain HTTP is supported. Sensitive card authentication data is not sent or received by terminals, but we still strongly encourage developers and merchants to favor HTTPS on port 8443./p>h3 idssl-tls>SSL/TLS/h3>p>Because terminals run on private networks, conventional SSL or TLS based on the majorcertificate authorities is not supported. When BlockChyp terminals are activated,a unique certificate is generated and signed by BlockChyp's own root certificate authority.The root certificate is provided here in PEM format./p>p>strong>BlockChyp Root Certificate For Private Terminal Networks:/strong>/p>div classcenter-column>-----BEGIN CERTIFICATE-----MIIFAjCCAuqgAwIBAgIBATANBgkqhkiG9w0BAQsFADAgMR4wHAYDVQQDDBVCbG9ja0NoeXAgSW50ZXJuYWwgQ0EwIBcNMTgwMTAxMDAwMDA4WhgPNDc1NTExMjkwMDAwMDhaMCAxHjAcBgNVBAMMFUJsb2NrQ2h5cCBJbnRlcm5hbCBDQTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBANyWuVhDiqeCrHMxbTv5PN5UOZdR8n4PPwUVz0dALnLS7Lkl9nnuBxUK5XFGsZHBQ3GqSsWgA0HBUAAkKY/hzDIY+mrKOTMFMhoFSKmcNwmdt+NXuUtYwL5STsr1U/XnxcizsSEHcGP5LhIH16AY0XYMVzNTBXrylH7OHf/pPJaVbuywAkiyrEV+lTo1mVTOCucGoNRPogluuyfbBCUH9bWBajbjHWdyiX58IV786JWkw5ogLXgDekrrzdVxQH1t2kN2PvXNHGOBlB0NL/QwKHxfbvgIu6EkyEXvvSuFclgaM3x38zcEaIS8id/wZYkwZXAqquR5Hi5fqPILC1xmRF+zC1GH1uJ+gsQuwqwaiwmD9Rcbm2ZOSVntQy5bCF7IzPlMHzMlt33dF9mZo9bJwFO1APdpeWy+Oogan1k/yS2EPnkAv+DiRpNf2it6n86+X7Z4C6QGgP5+rfc53uxeaF8gPLgXViaHHTZDNflxaNjgKD0xAwB3Yhca8RQSjRPwKYk1FrbhTSAIidnwmA4jrV7juZ2RSWA99VzRO68OmE/7NygxGgo995pPc+s6DO6IOnZvT2tSs0b2UmEKT51/cf93lv+phX/69hTCctMEYoIGNRAvcISA0lfTWHAbiRzMyagtuiRMttS7C+IshsgBrjHSHMsEYj8RhRnR0FvmChUNAgMBAAGjRTBDMB0GA1UdDgQWBBSBl1rnpf7Omve8fXPl9EltnlcqGTASBgNVHRMBAf8ECDAGAQH/AgEBMA4GA1UdDwEB/wQEAwIBBjANBgkqhkiG9w0BAQsFAAOCAgEAkt9ywLJvM0TjEUjlC32niE8mNIPX5azHJ0++PlZ2Fc7ZKy4nntt2YErll4qEOB8ED2VaLQuxx0O9H2oh1QsMuxT3rQ4SDNmQVH9vUYJWgIkYjY1zKubEyktvoZyi8xK5e0/ME//vU0ru6y0dmcFtDvpwm/JZPjoVKHK58JpCKH8xhVxQo7NxAIf8Ow+fr58plDQP1CbfjO1gJpFg7lQ282rz9n0Ju2mXm3guclcx74mDJGlzGLGCJCnuQxta8Dv/Cg8+kNM36boORMChaoAgIerXL17EhyUh3ZsSaxEchqvCWtLv1+ekhGpFA08xS33r1GgQV/cyunuz3czQ0Y/7UjKluo6sbS0RmVtAWJA/DhwXgQlHlFyROmhGpcKXeLc7+LrBZxITVuQk8Mg9aceAnzBqjeTjQNPQJkOwqIFgDUXNNqvA5mhn/j25u8CcDY/0p5C4tFQc1npgQwJZAwRGEvFmXVDgEZ8FFkzhn74oxI99Xs1HGc9zO/uPGV0cahaj9xspMPMBe5Q2mNhVca6+RIZPSIcVbsgYy+2QDBep7NpraQgG7V0f2XTuuLBaPXbY9PZLFklSSZOLXAuuOk0G57lfyVFRNAZ2R3uQdkDpx90Ti6PDWj9M6x1pjD1XNpXvgH2k91jjsK67khN+4bWoFBsfrMYt6vgjtXyv0kf12y0-----END CERTIFICATE-----/div>aside classwarning>b>Warning/b>p>Dont globally trust the BlockChyp root certificate. It should be trusted only by the HTTP client instances that communicate with payment terminals. Use your platform default certificate bundles for all other HTTP communication, including with the BlockChyp gateway./p>/aside>h3 ida-sample-request>A Sample Request/h3>p>Before we get too much further, let's take a look at a basic request. The example below shows a simple form of a charge request./p>p>POST: code>https://<IP_ADDRESS>:8443/api/charge/code>/p>div classcenter-column>Request:POST /api/charge HTTP/1.1Host: 192.168.50.245{apiKey: CINR73MIHX337KMRHW7BI5I2AM,bearerToken: JTLQJNLSM4IGCKJC2MK7COW2VA,signingKey: c7722b911f9821e742f248af8449f12f06304c18b48b902f7cdef3d9dea7ed34request: { amount: 20.55, terminalName: Cashier #1, }}Response:HTTP/1.1 200 OK{ approved:true, responseDescription:Approved, transactionId:NZ6FGYAYLYI6TLVWNSLM7WZLHE, transactionRef:cfd068099a4280f1f09a965d9cc522f25ef4e06a95c9a9461d59fa5deed62180, transactionType:charge,timestamp:2019-01-15T00:42:36Z, tickBlock:000e61f8204a2a372cac288f833a8e0949dd50d0074d5133432dce4e78d97913, authCode:612797, entryMethod:CHIP, paymentType:VISA, maskedPan:************0010, cardHolder:Test/Card 01 , partialAuth:false, altCurrency:false, currencyCode:USD, requestedAmount:20.55, authorizedAmount:20.55, receiptSuggestions: { AID:A0000000031010, ARQC:E0A09074268A87F4, IAD:06010A03A0B800, TVR:0240008000, TSI:E800, merchantName:Test Merchant, applicationLabel:VISA CREDIT, requestSignature:true, maskedPan:************0010, authorizedAmount:20.55, transactionType:charge, entryMethod:CHIP }}/div>p>You can refer to terminals by their IP address or host names if you've configured them for your network. We recommend avoiding the use of manual IP address configuration in your systems as IP addresses can be obtained on demand from the Payment Gateway's Terminal Route API. This API returns the current private IP address and provides for a more robust implementation in the event that installers or merchants fail to statically configure IP addresses for terminals./p>h3 idterminal-ping-api-test>Terminal Ping ( /api/test )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/test/td>/tr>/tbody>/table>p>strong>URL Pattern:/strong> code>https://<IP_ADDRESS>:8443/api/test/code>/p>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This simple test transaction helps ensure good communication with a payment terminal and is usually the first test you'll run in development./p>p>It tests communication with the terminal and returns a positive response if everythingis okay. It works the same way in local or cloud relay mode./p>p>If you get a positive response, you've successfully verified all of the following:/p>ul>li>The terminal is online./li>li>There is a valid route to the terminal./li>li>The API Credentials are valid./li>/ul>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/test HTTP/1.1Host: 192.168.50.15:8443Content-Length: 260Timestamp: 2021-05-19T20:47:42Z{ apiKey: CJ27KK4SBHCQG64TUL2HYJTZNU, bearerToken: ML4VG7HER3YYA2FB7BRF7KDMNE, signingKey: 2b5618fb5736adc7a0cb6188d3b68dae66d461592838fc7d5048ee90b1bf5a38, request: { terminalName: Test Terminal }}Response:HTTP/1.1 200 OK{ success: true, transactionType: ping, test: false}/div>h3 idcharge-api-charge-2>Charge ( /api/charge )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/charge/td>/tr>/tbody>/table>p>strong>URL Pattern:/strong> code>https://<IP_ADDRESS>:8443/api/charge/code>/p>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>Our most popular transaction executes a standard authorization and capture.This is the most basic ofbasic payment transactions, typically used in conventional retail./p>p>Charge transactions can use a payment terminal to capture a payment oruse a previously enrolled payment token./p>p>strong>Terminal Transactions/strong>/p>p>For terminal transactions, make sure you pass in the terminal name using the code>terminalName/code> property./p>p>strong>Token Transactions/strong>/p>p>If you have a payment token, omit the code>terminalName/code> property and pass in the token with the code>token/code>property instead./p>p>strong>Card Numbers and Mag Stripes/strong>/p>p>You can also pass in PANs and Mag Stripes, but you probably shouldn't, as this willput you in PCI scope and the most common vector for POS breaches is keylogging.If you use terminals for manual card entry, you'll bypass any keyloggers thatmight be maliciously running on the point-of-sale system./p>p>strong>Common Variations/strong>/p>ul>li>strong>Gift Card Redemption/strong>: There's no special API for gift card redemption in BlockChyp. Simply execute a plain charge transaction and if the customer swipes a gift card, our terminals will identify the gift card and run a gift card redemption. Also note that if for some reason the gift card's original purchase transaction is associated with fraud or a chargeback, the transaction will be rejected./li>li>strong>EBT/strong>: Set the code>CardType/code> field to code>blockchyp.CardTypeEBT/code> to process an EBT SNAP transaction. Note that test EBT transactions always assume a balance of $100.00, so test EBT transactions over that amount may be declined./li>li>strong>Cash Back/strong>: To enable cash back for debit transactions, set the code>CashBack/code> field. If the card presented isn't a debit card, the code>CashBack/code> field will be ignored./li>li>strong>Manual Card Entry/strong>: Set the code>ManualEntry/code> field to enable manual card entry. Good as a backup when chips and MSR's don't work or for more secure phone orders. You can even combine the code>ManualEntry/code> field with the code>CardType/code> field set to code>blockchyp.CardTypeEBT/code> for manual EBT card entry./li>li>strong>Inline Tokenization/strong>: You can enroll the payment method in the token vault inline with a charge transaction by setting the code>Enroll/code> field. You'll get a token back in the response. You can even bind the token to a customer record if you also pass in customer data./li>li>strong>Prompting for Tips/strong>: Set the code>PromptForTip/code> field if you'd like to prompt the customer for a tip before authorization. Good for pay-at-the-table and other service related scenarios./li>li>strong>Cash Discounting and Surcharging/strong>: The code>Surcharge/code> and code>CashDiscount/code> fields can be used together to support cash discounting or surcharge problems. Consult the Cash Discount documentation for more details./li>li>strong>Cryptocurrency/strong> The code>Cryptocurrency/code> field can be used to switch the standard present card screen to a cryptocurrency screen. The field value can be code>ANY/code> to enable any supported cryptocurrency or a single currency code such as code>BTC/code> for Bitcoin./li>/ul>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/charge HTTP/1.1Host: 192.168.50.15:8443Content-Length: 438Timestamp: 2021-05-19T20:51:37Z{ apiKey: CJ27KK4SBHCQG64TUL2HYJTZNU, bearerToken: ML4VG7HER3YYA2FB7BRF7KDMNE, signingKey: 2b5618fb5736adc7a0cb6188d3b68dae66d461592838fc7d5048ee90b1bf5a38, request: { test: true, timeout: 120, amount: 42.00, terminalName: Test Terminal }}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: approved, approved: true, authCode: 522340, transactionId: NK4XCBVYVMI6XFBOAJBKYEIAAU, batchId: NK4XCAVYVMI6XFBOAJBKYEIAAU, transactionType: charge, timestamp: 2021-05-19T20:51:45Z, tickBlock: 0006728fcc122a109f6454141ee8027d5a4ddb294ea87f6ceac5375cb75e3923, test: true, partialAuth: false, altCurrency: false, fsaAuth: false, currencyCode: USD, requestedAmount: 42.00, authorizedAmount: 42.00, remainingBalance: , tipAmount: 0.00, taxAmount: 0.00, requestedCashBackAmount: 0.00, authorizedCashBackAmount: 0.00, entryMethod: CHIP, paymentType: VISA, maskedPan: ************0010, cardHolder: UAT USA/Test Card 04, expMonth: 12, expYear: 22, receiptSuggestions: { aid: A0000000031010, arqc: E8AC3C7370C2D4E4, iad: 06010A03A0B800, tvr: 8000008800, tsi: 6800, merchantName: CLI Regression Test, applicationLabel: VISA CREDIT, requestSignature: false, maskedPan: ************0010, authorizedAmount: 42.00, transactionType: charge, entryMethod: CHIP, cashBackAmount: 0.00, surcharge: 0.00, cashDiscount: 0.00 }, storeAndForward: false}/div>h3 idpreauthorization-api-preauth-2>Preauthorization ( /api/preauth )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/preauth/td>/tr>/tbody>/table>p>strong>URL Pattern:/strong> code>https://<IP_ADDRESS>:8443/api/preauth/code>/p>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>A preauthorization puts a hold on funds and must be captured later. This is usedin scenarios where the final transaction amount might change. A common example is fine dining, where a tip adjustment is required before final settlement./p>p>Another use case for preauthorization is e-commerce. Typically, an online orderis preauthorized at the time of the order and then captured when the order ships./p>p>Preauthorizations can use a payment terminal to capture a payment oruse a previously enrolled payment token./p>p>strong>Terminal Transactions/strong>/p>p>For terminal transactions, make sure you pass in the terminal name using the code>terminalName/code> property./p>p>strong>Token Transactions/strong>/p>p>If you have a payment token, omit the code>terminalName/code> property and pass in the token with the code>token/code>property instead./p>p>strong>Card Numbers and Mag Stripes/strong>/p>p>You can also pass in PANs and Mag Stripes, but you probably shouldn't, as this willput you in PCI scope and the most common vector for POS breaches is key logging.If you use terminals for manual card entry, you'll bypass any key loggers thatmight be maliciously running on the point-of-sale system./p>p>strong>Cryptocurrency/strong>/p>p>Note that preauths are not supported for cryptocurrency./p>p>strong>Common Variations/strong>/p>ul>li>strong>Manual Card Entry/strong>: Set the code>ManualEntry/code> field to enable manual card entry. Good as a backup when chips and MSR's don't work or for more secure phone orders. You can even combine the code>ManualEntry/code> field with code>CardType/code> set to code>blockchyp.CardTypeEBT/code> for manual EBT card entry./li>li>strong>Inline Tokenization/strong>: You can enroll the payment method in the token vault in line with a charge transaction by setting the code>Enroll/code> field. You'll get a token back in the response. You can even bind the token to a customer record if you also pass in customer data./li>li>strong>Prompting for Tips/strong>: Set the code>PromptForTip/code> field if you'd like to prompt the customer for a tip before authorization. You can prompt for tips as part of a preauthorization, although it's not a very common approach./li>li>strong>Cash Discounting and Surcharging/strong>: The code>Surcharge/code> and code>CashDiscount/code> fields can be used together to support cash discounting or surcharge problems. Consult the Cash Discount documentation for more details./li>/ul>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/preauth HTTP/1.1Host: 192.168.50.15:8443Content-Length: 438Timestamp: 2021-05-19T21:00:25Z{ apiKey: CJ27KK4SBHCQG64TUL2HYJTZNU, bearerToken: ML4VG7HER3YYA2FB7BRF7KDMNE, signingKey: 2b5618fb5736adc7a0cb6188d3b68dae66d461592838fc7d5048ee90b1bf5a38, request: { test: true, timeout: 120, amount: 42.00, terminalName: Test Terminal }}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: approved, approved: true, authCode: 641343, transactionId: UM4CJYVYVMI6XJY6AJBKYEIAAI, batchId: NK4XCAVYVMI6XFBOAJBKYEIAAU, transactionType: preauth, timestamp: 2021-05-19T21:00:33Z, tickBlock: 0006728fcc122a109f6454141ee8027d5a4ddb294ea87f6ceac5375cb75e3923, test: true, partialAuth: false, altCurrency: false, fsaAuth: false, currencyCode: USD, requestedAmount: 42.00, authorizedAmount: 42.00, remainingBalance: , tipAmount: 0.00, taxAmount: 0.00, requestedCashBackAmount: 0.00, authorizedCashBackAmount: 0.00, entryMethod: CONTACTLESS EMV, paymentType: DISC, maskedPan: ************0133, cardHolder: UAT USA/Test Card 15, expMonth: 12, expYear: 23, avsResponse: , receiptSuggestions: { aid: A0000001523010, arqc: D3599650B705DCAA, iad: 0115209000000000B800, tvr: 8000008000, tsi: 0800, merchantName: CLI Regression Test, applicationLabel: DISCOVER CL, requestSignature: false, maskedPan: ************0133, authorizedAmount: 42.00, transactionType: preauth, entryMethod: CONTACTLESS EMV, cashBackAmount: 0.00, surcharge: 0.00, cashDiscount: 0.00 }, customer: null, whiteListedCard: null, storeAndForward: false}/div>h3 idenroll-api-enroll-2>Enroll ( /api/enroll )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/enroll/td>/tr>/tbody>/table>p>strong>URL Pattern:/strong> code>https://<IP_ADDRESS>:8443/api/enroll/code>/p>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API allows you to tokenize and enroll a payment method in the tokenvault. You can also pass in customer information and associate thepayment method with a customer record./p>p>A token is returned in the response that can be used in subsequent charge,preauth, and refund transactions./p>p>strong>Gift Cards and EBT/strong>/p>p>Gift Cards and EBT cards cannot be tokenized./p>p>strong>E-Commerce Tokens/strong>/p>p>The tokens returned by the enroll API and the e-commerce web tokenizerare the same tokens and can be used interchangeably./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/enroll HTTP/1.1Host: 192.168.50.15:8443Content-Length: 275Timestamp: 2021-05-19T21:29:08Z{ apiKey: CJ27KK4SBHCQG64TUL2HYJTZNU, bearerToken: ML4VG7HER3YYA2FB7BRF7KDMNE, signingKey: 2b5618fb5736adc7a0cb6188d3b68dae66d461592838fc7d5048ee90b1bf5a38, request: { test: true, timeout: 120, terminalName: Test Terminal }}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: approved, approved: true, authCode: 893797, transactionId: UM4CJ2NYVMI6XJY6AJBKYEIAAI, transactionType: enroll, timestamp: 2021-05-19T21:29:15Z, tickBlock: 00086bc6fc219f8f0121af0be188c5d5b32376aae9d23d56366b41a8541788b8, test: true, token: GNII7E3QX37B4D6UNPJWKB4SVM, entryMethod: CHIP, paymentType: VISA, maskedPan: ************0010, cardHolder: UAT USA/Test Card 04, expMonth: 12, expYear: 22, receiptSuggestions: { aid: A0000000031010, arqc: DD2EB9F5816D0A97, iad: 06010A03A0B800, tvr: 8000008800, tsi: 6800, merchantName: CLI Regression Test, applicationLabel: VISA CREDIT, requestSignature: false, maskedPan: ************0010, authorizedAmount: , transactionType: enroll, entryMethod: CHIP }}/div>h3 idcard-metadata-api-card-metadata-2>Card Metadata ( /api/card-metadata )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/card-metadata/td>/tr>/tbody>/table>p>strong>URL Pattern:/strong> code>https://<IP_ADDRESS>:8443/api/card-metadata/code>/p>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API allows you to retrieve card metadata./p>p>Card metadata requests can use a payment terminal to retrieve metadata oruse a previously enrolled payment token./p>p>strong>Terminal Transactions/strong>/p>p>For terminal transactions, make sure you pass in the terminal name using the code>terminalName/code> property./p>p>strong>Token Transactions/strong>/p>p>If you have a payment token, omit the code>terminalName/code> property and pass in the token with the code>token/code>property instead./p>p>strong>Card Numbers and Mag Stripes/strong>/p>p>You can also pass in PANs and Mag Stripes, but you probably shouldn't, as this willput you in PCI scope and the most common vector for POS breaches is keylogging.If you use terminals for manual card entry, you'll bypass any keyloggers thatmight be maliciously running on the point-of-sale system./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/card-metadata HTTP/1.1Host: 192.168.50.15:8443Content-Length: 438Timestamp: 2021-05-19T20:51:37Z{ apiKey: CJ27KK4SBHCQG64TUL2HYJTZNU, bearerToken: ML4VG7HER3YYA2FB7BRF7KDMNE, signingKey: 2b5618fb5736adc7a0cb6188d3b68dae66d461592838fc7d5048ee90b1bf5a38, request: { test: true, timeout: 120, terminalName: Test Terminal }}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: approved, cardMetadata: { cardBrand: MC, issuerName: Chase Bank USA, l3: false, l2: false, productType: MCC, productName: MCC - Chase credit card, ebt: false, debit: false, healthcare: false, prepaid: false, region: , country: USA }}/div>h3 idgift-card-activation-api-gift-activate-2>Gift Card Activation ( /api/gift-activate )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/gift-activate/td>/tr>/tbody>/table>p>strong>URL Pattern:/strong> code>https://<IP_ADDRESS>:8443/api/gift-activate/code>/p>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API activates or adds value to BlockChyp gift cards.Just pass in the terminal name and the amount to add to the card.Once the customer swipes their card, the terminal will use keyson the mag stripe to add value to the card./p>p>You don't need to handle a new gift card activation or a gift card recharge anydifferently. The terminal firmware will figure out what to do on itsown while also returning the new balance for the gift card./p>p>This is the part of the system where BlockChyp's blockchain DNA comesclosest to the surface. The BlockChyp gift card system doesn't reallyuse gift card numbers. This means they can't be stolen./p>p>BlockChyp identifies cards with an elliptic curve public key instead.Gift card transactions are actually blocks signed with those keys.This means there are no shared secrets sent over the network.To keep track of a BlockChyp gift card, hang on to the strong>public key/strong> returnedduring gift card activation. That's the gift card's elliptic curve public key./p>p>We sometimes print numbers on our gift cards, but these are actuallydecimal encoded hashes of a portion of the public key to make our giftcards seem em>normal/em> to em>normies/em>. They can be usedfor balance checks and play a lookup role in online gift cardauthorization, but are of little use beyond that./p>p>strong>Voids and Reversals/strong>/p>p>Gift card activations can be voided and reversed just like any otherBlockChyp transaction. Use the Transaction ID or Transaction Refto identify the gift activation transaction as you normally would forvoiding or reversing a conventional payment transaction./p>p>strong>Importing Gift Cards/strong>/p>p>BlockChyp does have the ability to import gift card liability fromconventional gift card platforms. Unfortunately, BlockChyp does notsupport activating cards on third party systems. However, you can importyour outstanding gift cards and customers can swipe them on theterminals like BlockChyp's standard gift cards./p>p>No special coding is required to access this feature. The gateway andterminal firmware handle everything for you./p>p>strong>Third Party Gift Card Networks/strong>/p>p>BlockChyp does not currently provide any native support for other gift cardplatforms beyond importing gift card liability. We do have a white listing systemthat can be used to support your own custom gift card implementations. We have a security reviewprocess before we can allow a BIN range to be white listed, so contactsupport@blockchyp.com if you need to white list a BIN range./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/gift-activate HTTP/1.1Host: 192.168.50.15:8443Content-Length: 352Timestamp: 2021-05-19T21:44:44Z{ apiKey: CJ27KK4SBHCQG64TUL2HYJTZNU, bearerToken: ML4VG7HER3YYA2FB7BRF7KDMNE, signingKey: 2b5618fb5736adc7a0cb6188d3b68dae66d461592838fc7d5048ee90b1bf5a38, request: { test: true, timeout: 120, amount: 100.00, terminalName: Test Terminal }}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: APPROVED, transactionId: UM4CJ5FYVMI6XJY6AJBKYEIAAI, transactionType: gift_activate, timestamp: 2021-05-19T21:44:59Z, tickBlock: 000462ab1ac92e966854cd3a4b03bd9caab185ba16234e96ff9ea26c3d518a56, test: true, approved: true, amount: 100.00, currentBalance: 100.00, currencyCode: USD, publicKey: 11kek9vHKFCRWrgjn4PJYPxaXQSjQma95v4f5Cfw9wi2zB1Ad9m, maskedPan: ************7089}/div>h3 idbalance-api-balance-2>Balance ( /api/balance )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/balance/td>/tr>/tbody>/table>p>strong>URL Pattern:/strong> code>https://<IP_ADDRESS>:8443/api/balance/code>/p>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API checks a gift or EBT card balance./p>p>strong>Gift Card Balance Checks/strong>/p>p>For gift cards, pass in a terminal name and the customer will be promptedto swipe a card on that terminal. The remaining balance will be displayedbriefly on the terminal screen and the API response will include the gift card's public key and the remaining balance./p>p>strong>EBT Balance Checks/strong>/p>p>All EBT transactions require a PIN, so to check an EBT card balance,you need to pass in the code>ebt/code> flag just like you would for a normal EBTcharge transaction. The customer will be prompted to swipe their card andenter a PIN code. If everything checks out, the remaining balance on the card will be displayed on the terminal for the customer and returned with the API response./p>p>strong>Testing Gift Card Balance Checks/strong>/p>p>Test gift card balance checks work no differently than live gift cards. Youmust activate a test gift card first to test balance checks. Testgift cards are real blockchain cards that live on our parallel test blockchain./p>p>strong>Testing EBT Gift Card Balance Checks/strong>/p>p>All test EBT transactions assume a starting balance of $100.00. As a result,test EBT balance checks always return a balance of $100.00./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/balance HTTP/1.1Host: 192.168.50.15:8443Timestamp: 2021-05-19T21:54:34Z{ apiKey: OGT5KOOHJCSSILOQ7AMJK32ZAE, bearerToken: SEA4XD7KMBQRQGJL2VMHMNXS34, signingKey: 02e235dc97e318c21a37c4259142a1b4f688cc0e511fbaa4079df6db22220a86, request: { test: true, timeout: 120, terminalName: Test Terminal }}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: , transactionId: UM4CJ4FYVMI6XJY6AJBKYEIAAI, transactionType: balance, tickBlock: 000462ab1ac92e966854cd3a4b03bd9caab185ba16234e96ff9ea26c3d518a56, test: true, maskedPan: ************7089, publicKey: 11kek9vHKFCRWrgjn4PJYPxaXQSjQma95v4f5Cfw9wi2zB1Ad9m, avsResponse: , receiptSuggestions: { merchantName: CLI Regression Test, requestSignature: false, maskedPan: ************7089, authorizedAmount: , transactionType: balance, entryMethod: SWIPE }, remainingBalance: 100.00}/div>h3 idterminal-clear-api-clear>Terminal Clear ( /api/clear )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/clear/td>/tr>/tbody>/table>p>strong>URL Pattern:/strong> code>https://<IP_ADDRESS>:8443/api/clear/code>/p>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API interrupts whatever a terminal may be doing and returns it to theidle state./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/clear HTTP/1.1Host: 192.168.50.15:8443Timestamp: 2021-05-19T22:14:27Z{ apiKey: OGT5KOOHJCSSILOQ7AMJK32ZAE, bearerToken: SEA4XD7KMBQRQGJL2VMHMNXS34, signingKey: 02e235dc97e318c21a37c4259142a1b4f688cc0e511fbaa4079df6db22220a86, request: { test: true, timeout: 120, terminalName: Test Terminal }}Response:HTTP/1.1 200 OK{ success:true, errorMessage:}/div>h3 idterminal-status-api-terminal-status-2>Terminal Status ( /api/terminal-status )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/terminal-status/td>/tr>/tbody>/table>p>strong>URL Pattern:/strong> code>https://<IP_ADDRESS>:8443/api/terminal-status/code>/p>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API returns the current status of a payment terminal. This is typically usedas a way to determine if the terminal is busy before sending a new transaction./p>p>If the terminal is busy, code>idle/code> will be false and the code>status/code> field will returna short string that indicates the transaction type currently in progress. The systemwill also return the timestamp of the last status change in the code>since/code> field./p>p>The code>cardInSlot/code> field in the response will indicates whether or not a card is currently in the card reader slot./p>p>If the system is running a payment transaction and you wisely passed in aTransaction Ref, this API will also return the Transaction Ref of the in progresstransaction./p>p>The table below lists all possible status responses./p>table>thead>tr>th>Status Code/th>th>Description/th>/tr>/thead>tbody>tr>td>idle/td>td>The terminal is idle and ready for transactions. The default branding is being displayed./td>/tr>tr>td>activate/td>td>The terminal is in the process of activating and pairing with the merchant account./td>/tr>tr>td>balance/td>td>A balance check (EBT or Gift Card) is pending on the terminal./td>/tr>tr>td>boolean-prompt/td>td>A boolean prompt (yes/no) operation is pending on the terminal./td>/tr>tr>td>signature/td>td>A signature capture is pending./td>/tr>tr>td>crypto/td>td>A cryptocurrency transaction is pending./td>/tr>tr>td>enroll/td>td>A token vault enrollment operation is pending./td>/tr>tr>td>gift-activate/td>td>A gift card activation operation is in progress./td>/tr>tr>td>message/td>td>The terminal is displaying a custom message./td>/tr>tr>td>charge/td>td>The terminal is executing a charge transaction./td>/tr>tr>td>preauth/td>td>The terminal is executing a preauth transaction./td>/tr>tr>td>refund/td>td>The terminal is executing a refund transaction./td>/tr>tr>td>survey/td>td>The terminal is displaying post transaction survey questions./td>/tr>tr>td>terms-and-conditions/td>td>The terminal is pending terms and conditions acceptance and signature./td>/tr>tr>td>text-prompt/td>td>The terminal is awaiting response to a text input prompt./td>/tr>tr>td>txdisplay/td>td>The terminal is displaying transaction and/or line item level details./td>/tr>/tbody>/table>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/terminal-status HTTP/1.1Host: 192.168.50.15:8443Timestamp: 2021-05-19T22:18:23Z{ apiKey: OGT5KOOHJCSSILOQ7AMJK32ZAE, bearerToken: SEA4XD7KMBQRQGJL2VMHMNXS34, signingKey: 02e235dc97e318c21a37c4259142a1b4f688cc0e511fbaa4079df6db22220a86, request: { test: true, timeout: 120, terminalName: Test Terminal }}Response:HTTP/1.1 200 OK{ success: true, error: , idle: false, cardInSlot: true, status: charge, since: 2021-05-19T22:18:07.272120999Z}/div>h3 idterms-amp-conditions-capture-api-tc>Terms & Conditions Capture ( /api/tc )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/tc/td>/tr>/tbody>/table>p>strong>URL Pattern:/strong> code>https://<IP_ADDRESS>:8443/api/tc/code>/p>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Terms & Conditions Management/li>/ul>p>This API allows you to prompt a customer to accept a legal agreement on the terminaland (usually) capture their signature./p>p>Content for the agreement can be specified in two ways. You can reference apreviously configured T&C template or pass in the full agreement text with every request./p>p>strong>Using Templates/strong>/p>p>If your application doesn't keep track of agreements you can leverage BlockChyp'stemplate system. You can create any number of T&C Templates in the merchant dashboardand pass in the code>tcAlias/code> flag to specify which one should display./p>p>strong>Raw Content/strong>/p>p>If your system keeps track of the agreement language or executes complicated mergingand rendering logic, you can bypass our template system and pass in the full text withevery transaction. Use code>tcName/code> to pass in the agreement name and code>tcContent/code> topass in the contract text. Note that only plain text is supported./p>p>strong>Bypassing Signatures/strong>/p>p>Signature images are captured by default. If for some reason this doesn't fit youruse case and you'd like to capture acceptance without actually capturing a signature image, setthe code>disableSignature/code> flag in the request./p>p>strong>Terms & Conditions Log/strong>/p>p>Every time a user accepts an agreement on the terminal, the signature image (if captured),will be uploaded to the gateway. The image will also be added to the log along with the full text of theagreement. This preserves the historical record in the event that standard agreementsor templates change over time./p>p>strong>Associating Agreements with Transactions/strong>/p>p>To associate a Terms & Conditions log entry with a transaction, just pass in theTransaction ID or Transaction Ref for the associated transaction./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/tc HTTP/1.1Host: 192.168.50.15:8443Timestamp: 2021-05-19T22:21:59Z{ apiKey: OGT5KOOHJCSSILOQ7AMJK32ZAE, bearerToken: SEA4XD7KMBQRQGJL2VMHMNXS34, signingKey: 02e235dc97e318c21a37c4259142a1b4f688cc0e511fbaa4079df6db22220a86, request: { test: true, timeout: 120, terminalName: Test Terminal, tcName: Contract Title, tcContent: Blah Blah Blah, sigRequired: true }}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: , test: true}/div>h3 idcapture-signature-api-capture-signature-2>Capture Signature ( /api/capture-signature )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/capture-signature/td>/tr>/tbody>/table>p>strong>URL Pattern:/strong> code>https://<IP_ADDRESS>:8443/api/capture-signature/code>/p>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This endpoint captures a written signature from the terminal and returns theimage./p>p>Unlike the Terms & Conditions API, this endpoint performs basic signaturecapture with no agreement display or signature archival./p>p>Under the hood, signatures are captured in a proprietary vector format andmust be converted to a common raster format in order to be useful to mostapplications. At a minimum, you must specify an image format using thecode>sigFormat/code> parameter. Currently, JPG and PNG are supported./p>p>By default, images are returned in the JSON response as hex encoded binary.You can redirect the binary image output to a file using the code>sigFile/code>parameter./p>p>You can also scale the output image to your preferred width bypassing in a code>sigWidth/code> parameter. The image will be scaled to thatwidth, preserving the aspect ratio of the original image./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/capture-signature HTTP/1.1Host: 192.168.50.15:8443Timestamp: 2021-05-19T22:26:41Z{ apiKey: OGT5KOOHJCSSILOQ7AMJK32ZAE, bearerToken: SEA4XD7KMBQRQGJL2VMHMNXS34, signingKey: 02e235dc97e318c21a37c4259142a1b4f688cc0e511fbaa4079df6db22220a86, request: { test: true, timeout: 120, sigFormat: png, sigWidth: 100, terminalName: Test Terminal }}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: , sigFile: 89504e470d0a1a0a0000000d49484452000000640000001c080200000018f18daf0000029449444154789cec99bd6bea5018c6e3c52174e8d42e5d4ae950dab55b5b28a58398218bf831f90ff82fe8228aa3b889202e0e22282e82102110111c1407f1031dfc584451c121227234173c70f06ad424cd89dc92dfd693f77dcef33ea487d3d4280802a1238d3f9736f03fa1872503adc38ac5626f6f6f861d229188c61e9423684532992449f2988dc562a19913c5681496d7eb45b93c3e3e66b3d976bb9dcbe56e6f6fd13a00401b338ac11e160000c5717575359bcdf60a388e834f5d2ed769a9f178ecf3f9288afaf8f8c8e7f3385d8b83372c0080c9648259a4d3e963656eb71bd66c361bd1826ab52afacb3b9d4e71dadf076358ebf51a4d954824cef8d8c271dcde7aabd53a7de61ecb170718c342e754a9543aef63cbfdfd3d5ae179fefafa1a8562b3d9eaf53a7a9ac964e03a4dd3d82638308949b752a9c06142a190947a87c34110c4d3d313fcb156aba198bebfbf9bcde6618bd96c860583c1406dfbe2e00a0b8ef1f5f525b19ea228d8220882d3e9444945a3d1b3bb687601c2b20dc3307086e17028b1c56eb7ef1d462449f23c7fba2b1c0e4b797f0100a3d148ce04e260090b0e100c06a5b7dcdcdcec26954aa564ed451084d56a5dad56689de7798661dedfdf5141a150903fcabf7bfdb0ff109665a1b9e57229c3c70ec562517ae3ee3dee040f0f0fdd6e57d1403b267fd82fa2b8c5e3f1c8ea8ac7e3b0b1d3e928d894a6e963310502815eafa740f31083eadfb30c06034110e572f9f5f5555de5b3341a8dc964d2eff73f3f3fefeeee8c46a3bafa2acb21e6f33926e513bcbcbc60d5c7f589c6eff76352be20ea8705efd62ccba20bc4ef4195936f0ff85a592c161ce21744fd031efe710bbf883e3f3fab2e7e41b084f55bd1ff6121033d2c19e861c9400f4b067a5832f81b0000ffff6ccb8488b23957330000000049454e44ae426082}/div>h3 idnew-transaction-display-api-txdisplay>New Transaction Display ( /api/txdisplay )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/txdisplay/td>/tr>/tbody>/table>p>strong>URL Pattern:/strong> code>https://<IP_ADDRESS>:8443/api/txdisplay/code>/p>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API sends totals and line item level data to the terminal./p>p>At a minimum, you should send total information as part of a display request,including code>total/code>, code>tax/code>, and code>subtotal/code>./p>p>You can also send line item level data and each line item can have a code>description/code>,code>qty/code>, code>price/code>, and code>extended/code> price./p>p>If you fail to send an extended price, BlockChyp will multiply the code>qty/code> by thecode>price/code>. However, we strongly recommend you precalculate all the fields yourselfto ensure consistency. For example, your treatment of floating-point multiplication and rounding may differ slightly from BlockChyp's./p>p>strong>Discounts/strong>/p>p>You have the option to show discounts on the display as individual line itemswith negative values or you can associate discounts with a specific line item.You can apply any number of discounts to an individual line item with a descriptionand amount./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/txdisplay HTTP/1.1Host: 192.168.50.15:8443Timestamp: 2021-05-19T22:39:25Z{ apiKey: OGT5KOOHJCSSILOQ7AMJK32ZAE, bearerToken: SEA4XD7KMBQRQGJL2VMHMNXS34, signingKey: 02e235dc97e318c21a37c4259142a1b4f688cc0e511fbaa4079df6db22220a86, request: { async: false, queue: false, test: true, timeout: 120, terminalName: Test Terminal, transaction: { subtotal: 120.05, tax: 5.00, total: 125.05, items: { id: , description: Leki Trekking Poles, price: 135.05, quantity: 1, extended: 120.05, unitCode: , commodityCode: , productCode: , discounts: { description: Member Discount, amount: 10.00 } } } }}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: }/div>h3 idupdate-transaction-display-api-txdisplay>Update Transaction Display ( /api/txdisplay )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>PUT/td>td>/api/txdisplay/td>/tr>/tbody>/table>p>strong>URL Pattern:/strong> code>https://<IP_ADDRESS>:8443/api/txdisplay/code>/p>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>Similar to em>New Transaction Display/em>, this variant allows developers to updateline item level data currently being displayed on the terminal./p>p>This feature is designed for situations where you want to update the terminal display asitems are scanned. You'll only have to send information to theterminal that's changed, which usually means the new line item and updated totals./p>p>If the terminal is not in line item display mode and you invoke this endpoint,the first invocation will behave like a em>New Transaction Display/em> call./p>p>At a minimum, you should send total information as part of a display request,including code>total/code>, code>tax/code>, and code>subtotal/code>./p>p>You can also send line item level data and each line item can have a code>description/code>,code>qty/code>, code>price/code>, and code>extended/code> price./p>p>If you fail to send an extended price, BlockChyp will multiply the code>qty/code> by thecode>price/code>. However, we strongly recommend you precalculate all the fields yourselfto ensure consistency. For example, your treatment of floating-point multiplication and roundingmay differ slightly from BlockChyp's./p>p>strong>Discounts/strong>/p>p>You have the option to show discounts on the display as individual line itemswith negative values or you can associate discounts with a specific line item.You can apply any number of discounts to an individual line item with a descriptionand amount./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:PUT /api/txdisplay HTTP/1.1Host: 192.168.50.15:8443Timestamp: 2021-05-19T22:39:25Z{ apiKey: OGT5KOOHJCSSILOQ7AMJK32ZAE, bearerToken: SEA4XD7KMBQRQGJL2VMHMNXS34, signingKey: 02e235dc97e318c21a37c4259142a1b4f688cc0e511fbaa4079df6db22220a86, request: { async: false, queue: false, test: true, timeout: 120, terminalName: Test Terminal, transaction: { subtotal: 120.05, tax: 5.00, total: 125.05, items: { id: , description: Leki Trekking Poles, price: 135.05, quantity: 1, extended: 120.05, unitCode: , commodityCode: , productCode: , discounts: { description: Member Discount, amount: 10.00 } } } }}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: }/div>h3 iddisplay-message-api-message-2>Display Message ( /api/message )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/message/td>/tr>/tbody>/table>p>strong>URL Pattern:/strong> code>https://<IP_ADDRESS>:8443/api/message/code>/p>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API displays a message on the payment terminal./p>p>Just specify the target terminal and the message using the code>message/code> parameter./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/message HTTP/1.1Host: 192.168.50.15:8443Timestamp: 2021-05-19T22:52:14Z{ apiKey: OGT5KOOHJCSSILOQ7AMJK32ZAE, bearerToken: SEA4XD7KMBQRQGJL2VMHMNXS34, signingKey: 02e235dc97e318c21a37c4259142a1b4f688cc0e511fbaa4079df6db22220a86, request: { test: true, timeout: 120, terminalName: Test Terminal, message: Payments is broken. }}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: }/div>h3 idboolean-prompt-api-boolean-prompt-2>Boolean Prompt ( /api/boolean-prompt )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/boolean-prompt/td>/tr>/tbody>/table>p>strong>URL Pattern:/strong> code>https://<IP_ADDRESS>:8443/api/boolean-prompt/code>/p>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API prompts the customer to answer a yes or no question./p>p>You can specify the question or prompt with the code>prompt/code> parameter andthe response is returned in the code>response/code> field./p>p>This can be used for a number of use cases including starting a loyalty enrollmentworkflow or customer facing suggestive selling prompts./p>p>strong>Custom Captions/strong>/p>p>You can optionally override the "YES" and "NO" button captions byusing the code>yesCaption/code> and code>noCaption/code> request parameters./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/boolean-prompt HTTP/1.1Host: 192.168.50.15:8443Timestamp: 2021-05-19T22:58:39Z{ apiKey: HFZFFGV3P2KETBN24ZCVXJIDMI, bearerToken: 6NMRGWFFIFGAW7S2MKHTEFM2CQ, signingKey: b50bb2229c1773ef17a3a46dbc856e9732b0d1cad2a079a4c0c2587110f3cbe0, request: { async: false, queue: false, test: true, timeout: 120, terminalName: Test Terminal, yesCaption: Yes, noCaption: No, prompt: Should the payments industry be destroyed? }}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: , response: true}/div>h3 idtext-prompt-api-text-prompt-2>Text Prompt ( /api/text-prompt )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/text-prompt/td>/tr>/tbody>/table>p>strong>URL Pattern:/strong> code>https://<IP_ADDRESS>:8443/api/text-prompt/code>/p>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API prompts the customer to enter numeric or alphanumeric data./p>p>Due to PCI rules, free-form prompts are not permitted when the responsecould be any valid string. The reason for this is that a maliciousdeveloper (not you, of course) could use text prompts to ask the customer toinput a card number or PIN code./p>p>This means that instead of providing a prompt, you provide a code>promptType/code> instead./p>p>The prompt types currently supported are listed below:/p>ul>li>strong>phone/strong>: Captures a phone number./li>li>strong>email/strong>: Captures an email address./li>li>strong>first-name/strong>: Captures a first name./li>li>strong>last-name/strong>: Captures a last name./li>li>strong>customer-number/strong>: Captures a customer number./li>li>strong>rewards-number/strong>: Captures a rewards number./li>/ul>p>You can specify the prompt with the code>promptType/code> parameter andthe response is returned in the code>response/code> field./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/text-prompt HTTP/1.1Host: 192.168.50.15:8443Timestamp: 2021-05-19T23:11:37Z{ apiKey: HFZFFGV3P2KETBN24ZCVXJIDMI, bearerToken: 6NMRGWFFIFGAW7S2MKHTEFM2CQ, signingKey: b50bb2229c1773ef17a3a46dbc856e9732b0d1cad2a079a4c0c2587110f3cbe0, request: { test: true, timeout: 120, terminalName: Test Terminal, promptType: phone }}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: , response: 9136488888}/div>h3 idlist-queued-transactions-api-queue-list-2>List Queued Transactions ( /api/queue/list )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/queue/list/td>/tr>/tbody>/table>p>strong>URL Pattern:/strong> code>https://<IP_ADDRESS>:8443/api/queue/list/code>/p>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>Returns a list of transaction refs of transactions queued on a terminal.Details about the transactions can be retrieved using the Transaction StatusAPI./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:GET /api/queue/list HTTP/1.1Host: 192.168.50.15:8443Timestamp: 2021-05-19T23:11:37Z{ apiKey: HFZFFGV3P2KETBN24ZCVXJIDMI, bearerToken: 6NMRGWFFIFGAW7S2MKHTEFM2CQ, signingKey: b50bb2229c1773ef17a3a46dbc856e9732b0d1cad2a079a4c0c2587110f3cbe0, request: { timeout: 120, terminalName: Test Terminal }}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: , transactionRefs: a, b, c, ,}/div>h3 iddelete-queued-transaction-api-queue-delete-2>Delete Queued Transaction ( /api/queue/delete )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/queue/delete/td>/tr>/tbody>/table>p>strong>URL Pattern:/strong> code>https://<IP_ADDRESS>:8443/api/queue/delete/code>/p>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>Deletes one or all queued transactions from a terminal. If code>*/code> is passed asa transaction ref, then the entire terminal queue will be cleared. An error isreturned if the passed transaction ref is not queued on the terminal./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/queue/delete HTTP/1.1Host: 192.168.50.15:8443Timestamp: 2021-05-19T23:11:37Z{ apiKey: HFZFFGV3P2KETBN24ZCVXJIDMI, bearerToken: 6NMRGWFFIFGAW7S2MKHTEFM2CQ, signingKey: b50bb2229c1773ef17a3a46dbc856e9732b0d1cad2a079a4c0c2587110f3cbe0, request: { timeout: 120, terminalName: Test Terminal transactionRef: abc, }}Response:HTTP/1.1 200 OK{ success: true, error: , responseDescription: }/div>h3 idreboot-terminal-api-reboot>Reboot Terminal ( /api/reboot )/h3>table>thead>tr>th>HTTP Method/th>th>Path/th>/tr>/thead>tbody>tr>td>POST/td>td>/api/reboot/td>/tr>/tbody>/table>p>strong>URL Pattern:/strong> code>https://<IP_ADDRESS>:8443/api/reboot/code>/p>ul>li>strong>API Credential Types:/strong> Merchant/li>li>strong>Required Role:/strong> Payment API Access/li>/ul>p>This API reboots the terminal./p>p>strong>Sample Request and Response/strong>/p>div classcenter-column>Request:POST /api/reboot HTTP/1.1Host: 192.168.50.15:8443Timestamp: 2021-05-19T22:14:27Z{ apiKey: OGT5KOOHJCSSILOQ7AMJK32ZAE, bearerToken: SEA4XD7KMBQRQGJL2VMHMNXS34, signingKey: 02e235dc97e318c21a37c4259142a1b4f688cc0e511fbaa4079df6db22220a86 request: { terminalName: Test Terminal }}Response:HTTP/1.1 200 OK{ success:true, errorMessage:}/div>h1 idgetting-help>Getting Help/h1>p>We've done our best to make this documentation as complete as possible, but nodocumentation is perfect, especially in the payments industry./p>p>If you have questions or run into any problems, feel free to contact usat support@blockchyp.com./p> /div> div classdark-box> div classlang-selector> a href# data-language-nameshell>shell/a> a href# data-language-namego>go/a> a href# data-language-namecsharp>csharp/a> a href# data-language-namejava>java/a> a href# data-language-namephp>php/a> a href# data-language-nameruby>ruby/a> a href# data-language-namepython>python/a> a href# data-language-namejavascript>javascript/a> a href# data-language-nametypescript>typescript/a> a href# data-language-nameobjective_c>objective_c/a> a href# data-language-nameswift>swift/a> a href# data-language-namerust>rust/a> /div> /div> /div> /body>/html>

Subdomains

Date	Domain	IP
dashboard.blockchyp.com	2024-11-25	34.208.98.47
api.blockchyp.com	2024-11-25	34.208.98.47
betaapi.blockchyp.com	2024-11-25	44.241.9.144
docs.blockchyp.com	2025-12-03	3.175.34.91
test.blockchyp.com	2024-11-25	44.241.9.144
www.blockchyp.com	2024-11-25	44.241.9.144

View on OTX | View on ThreatMiner

Data with thanks to AlienVault OTX, VirusTotal, Malwr and others. [Sitemap]

Domain > docs.blockchyp.com

Is this malicious?

DNS Resolutions

Port 80

Port 443

Subdomains