CINXE.COM

<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en" dir="ltr"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> <meta http-equiv="x-ua-compatible" content="IE=edge"></meta><meta name="format-detection" content="telephone=no"></meta><meta name="viewport" content="width=device-width, initial-scale=1"></meta><meta name="search" content="algolia"></meta><meta name="use.ic" content="no"></meta><meta name="description" content="Liberate global commerce with all the tools you need for payments, payouts, and business everywhere."></meta><meta name="twitter:card" content="summary_large_image"></meta><meta name="meta:type" content="docs"></meta><meta name="meta:image" content="https://docs.rapyd.net/public/images/rapyd-documentation.png"></meta><meta name="og:image" content="https://docs.rapyd.net/public/images/rapyd-documentation.png"></meta><meta name="meta:description" content="Liberate global commerce with all the tools you need for payments, payouts, and business everywhere."></meta><meta name="tocstandalone" content="yes"></meta><meta name="theme" content="1"></meta><meta name="search.placeholder" content="Search"></meta><meta name="search.results" content="Search results"></meta><meta name="no.search.results" content="No results found"></meta><meta name="meta:title" content="API Reference | Rapyd Docs"></meta><meta name="og:title" content="API Reference | Rapyd Docs"></meta><meta name="meta:title_raw" content="API Reference"></meta><script type="text/javascript"> var theme = '1'; window.versionsfile = ''; window.indexDict = new Array(); window.store = {}; window.portalLanguage = 'en'; window.enterKey = 'select'; var fuse_threshold = 0.3; var local_csh = false; var anchoroption = true; var instantsearch_minlength = 1; var useanchorlinks = false; var collapseTocSectionOnLinkTitleClick = true; </script><title>API Reference</title><link rel="stylesheet" type="text/css" href="../css/docbook.css"></link><link rel="stylesheet" type="text/css" href="../css/font-awesome.css"></link><link rel="stylesheet" type="text/css" href="../css/roboto.font.css"></link><link rel="stylesheet" type="text/css" href="../css/theme1.css"></link><link rel="stylesheet" type="text/css" href="../css/theme1-colors.css"></link><link rel="stylesheet" type="text/css" href="../css/content-theme2.css"></link><link rel="stylesheet" type="text/css" href="../css/sm-core-css.css"></link><link rel="stylesheet" type="text/css" href="../css/sm-simple.css"></link><link rel="stylesheet" type="text/css" href="../css/style-print.css"></link><link rel="stylesheet" type="text/css" href="../css/style-common.css"></link><link rel="stylesheet" type="text/css" href="../css/html5.algoliasearch.css"></link><link rel="stylesheet" type="text/css" href="../css/style-modern-tables.css"></link><link rel="stylesheet" type="text/css" href="../css/graphical-lists.css"></link><link rel="stylesheet" type="text/css" href="../css/64d9f195367b2.css"></link><script src="../js/jquery-3/jquery-3.4.1.min.js" type="text/javascript"></script><script src="../js/jquery-migrate-3.4.1.min.js" type="text/javascript"></script><script src="../js/materialize.min.js" type="text/javascript"></script><script src="../js/bootstrap.min.js" type="text/javascript"></script><script src="../js/purl.js" type="text/javascript"></script><script src="../js/jquery.smartmenus.js" type="text/javascript"></script><script src="js/toc.js" type="text/javascript"></script><script src="../js/create-toc.js" type="text/javascript"></script><script src="../js/html5-2-mp-common.js" type="text/javascript"></script><script src="../js/html5-2-ajax.js" type="text/javascript"></script><script src="../js/checklist.js" type="text/javascript"></script><script src="../js/clipboard.min.js" type="text/javascript"></script><script src="../js/html5.algoliasearch.js" type="text/javascript"></script><script src="../js/csh.js" type="text/javascript"></script><script src="../js/jquery.paligocode.js" type="text/javascript"></script><script src="../js/layout-custom-script.js" type="text/javascript"></script><meta name="generator" content="Paligo"></meta><link rel="prev" href="webhooks.html#UUID-5d2a54d1-e115-fb62-d987-a3d81a8a5d53_UUID-3b9add7e-04a2-f777-4f95-684f23695018" title="Resend Webhook - Finite State Diagram"></link><link rel="next" href="api-reference.html#idp281243" title=""></link><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML" async="async"></script><link rel="icon" href="/favicon.ico" type="image/x-icon"></link><script type="text/javascript" src="../js/cookie-consent.js"></script><script type="text/javascript"> $(document).ready(function () { $(".mediaobject img").addClass('materialboxed'); //Exclude images with links $(".mediaobject a img").removeClass('materialboxed'); if (!document.documentMode) { $('.materialboxed').materialbox(); }}); </script><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/googlecode.min.css"></link><script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script><script type="text/javascript"> $(document).ready(function() { $('pre:not(.embedcode)').each(function() { /** * @type {string} */ var language = $(this).data('language'); if (language === 'plaintext' || language === 'text') { $(this).addClass(language).addClass('hljs'); return true; } else { var clone = this.cloneNode(true); hljs.highlightBlock(clone); $(this).empty().append($(clone).contents()); $(this).attr("class", $(clone).attr("class")); } }); }); </script><script type="text/javascript">var publication_id = 'en-UUID-2866af4c-e405-6c98-03ee-b1bf49cff329'; var algolia_application_id = 'FTL7TLZR1B'; var algolia_search_only_api_key = '27f27fd65bbaa767b82434123cf67ce9'; var use_breadcrumbs_for_algolia_searchresults = '1';</script><script src="https://cdn.jsdelivr.net/algoliasearch/3/algoliasearch.min.js"></script><script src="https://cdn.jsdelivr.net/autocomplete.js/0/autocomplete.jquery.min.js"></script></head><body class="theme1 page-toc collapsible-sidebar-nav current-toc-section-focus" data-spy="scroll" data-target=".section-nav-container" data-offset="100" data-link-prefix=""><style type="text/css"> div.skipnav { } div.skipnav a { position: fixed; left: -10000px; top: 1.5em; width: 1px; height: 1px; overflow: hidden; } div.skipnav a:focus, div.skipnav a:active, div.skipnav a:hover { background: white; color: black; box-shadow: 5px 5px 5px 0px rgba(0,0,0,0.5); position: fixed; left: 2em; top: 1.5em; width: auto; height: auto; overflow: visible; text-decoration: underline; z-index: 99999; /* has to be higher than the side panel */ } </style><div class="skipnav"><a href="#content-wrapper">Skip to main content</a></div><header class="site-header"><nav class="site-header-navbar navbar navbar-fixed-top"><div class="navbar-container"><div class="navbar-header"><button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target=".site-sidebar" aria-expanded="false" aria-controls="navbar"><span class="sr-only">Toggle navigation</span><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></button><div id="logotype-container" class="pull-left"><a class="navbar-brand" href="../index.html?lang=en"><img id="logotype-pageheader" src="../css/image/corporate-logo.svg" alt="Corporate logotype" data-role="logotype" class="logo"></img></a></div></div><div class="navbar-collapse collapse" id="navbar"></div></div></nav></header><div class="site-body"><div class="site-body-container"><div class="site-body-row"><aside class="site-sidebar"><div class="site-sidebar-header"><button type="button" class="navbar-toggle" aria-controls="nav-site-sidebar"><span class="sr-only">Toggle navigation</span><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></button><a href="../index.html?lang=en"><img id="logotype-pageheader" src="../css/image/corporate-logo.svg" alt="Corporate logotype" data-role="logotype" class="logo"></img></a></div><form class="site-sidebar-search" autocomplete="off"><input type="text" placeholder="Search" class="form-control search-field" id="aa-search-input"></input></form><div id="toc-standalone-placeholder"></div></aside><div class="site-content"><h1 class="publication-title">Documentation</h1><div class="toolbar"><div class="toolbar-tools"><div id="navbar" class="navbar-collapse collapse"></div><div class="tool-print"><i class="fa fa-print" aria-hidden="true">print</i></div><div class="tool-search"><i class="fa fa-search" aria-hidden="true"></i></div><button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target=".site-sidebar" aria-expanded="false" aria-controls="navbar"><span class="sr-only">Toggle navigation</span><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></button></div><div class="breadcrumb-container"><ul class="breadcrumb"><li class="breadcrumb-link"><a href="index-en.html">Documentation</a></li><li class="breadcrumb-node">API Reference</li></ul></div></div><main><div id="top-pager"><ul class="pager"><li class="previous"><a accesskey="p" class="prev pull-left prev visible-lg visible-md" id="header-navigation-prev" href="webhooks.html#UUID-5d2a54d1-e115-fb62-d987-a3d81a8a5d53_UUID-3b9add7e-04a2-f777-4f95-684f23695018">Prev</a></li><li class="next"><a accesskey="n" class="pull-right next visible-lg visible-md" id="header-navigation-next" href="api-reference.html#idp281243">Next</a></li></ul></div><article class="topic content-container" id="content-wrapper"><div id="topic-content" class="topic-content"><section xml:lang="en" lang="en" dir="ltr" class="section taxonomy-category-api-ref no-page-toc reused-publication" data-origin-id="UUID-96e3f667-5b55-751b-f3fb-f7b95c81a11c" data-permalink="api-reference.html" data-topic-level="1" data-relative-prefix="" data-publication-date="" id="UUID-96e3f667-5b55-751b-f3fb-f7b95c81a11c"><div class="titlepage"><div><div class="title"><h2 class="title" style="clear: both">API Reference</h2></div></div></div><p>Technical information for developers. Methods, parameters, webhooks, and error codes for Rapyd products. Also see <a class="xref linktype-publication" href="developer-guide.html" title="Developer Guide"><span class="xreftitle">Developer Guide</span></a>.</p><p>For recent updates, see <a class="xref linktype-component" href="api-changelog.html" title="API Changelog"><span class="xreftitle">API Changelog</span></a>.</p><section dir="ltr" class="section" data-origin-id="" data-publication-date="" id="idp281243"><div class="titlepage"><div><div class="title"><h3 class="title"></h3></div></div></div><p class="section-title">API Methods</p><section dir="ltr" class="section card-container" data-origin-id="" data-publication-date="" id="idp281246"><div class="titlepage"><div><div class="title"><h4 class="title"></h4></div></div></div><section dir="ltr" class="section card link" data-origin-id="" data-publication-date="" id="idp281248"><div class="titlepage"><div><div class="title"><h5 class="title"></h5></div></div></div><p class="card-link">en/rapyd-collect-363484.html</p><p class="icon-container"><span class="icon icon-collect md"></span></p><p class="card-title">Collect</p><p class="card-body">Collect funds from many different payment sources and transfer it to Rapyd Wallets - Payments, payment methods, subscriptions, checkout pages, escrows, and refunds.</p></section><section dir="ltr" class="section card link" data-origin-id="" data-publication-date="" id="idp281255"><div class="titlepage"><div><div class="title"><h5 class="title"></h5></div></div></div><p class="card-link">en/rapyd-disburse-368669.html</p><p class="icon-container"><span class="icon icon-disburse md"></span></p><p class="card-title">Disburse</p><p class="card-body">Transfer money from a Rapyd Wallet to a beneficiary outside the Rapyd system.</p></section><section dir="ltr" class="section card link" data-origin-id="" data-publication-date="" id="idp281262"><div class="titlepage"><div><div class="title"><h5 class="title"></h5></div></div></div><p class="card-link">en/rapyd-wallet-368670.html</p><p class="icon-container"><span class="icon icon-wallet md"></span></p><p class="card-title">Wallet</p><p class="card-body">The focal point for receiving, storing, and sending money. Each wallet holds one or more currency accounts.</p></section></section><section dir="ltr" class="section card-container" data-origin-id="" data-publication-date="" id="idp281269"><div class="titlepage"><div><div class="title"><h4 class="title"></h4></div></div></div><section dir="ltr" class="section card link" data-origin-id="" data-publication-date="" id="idp281271"><div class="titlepage"><div><div class="title"><h5 class="title"></h5></div></div></div><p class="card-link">en/rapyd-issuing-365115.html</p><p class="icon-container"><span class="icon icon-credit_card md"></span></p><p class="card-title">Card Issuing</p><p class="card-body">Provides bank cards funded by the Rapyd Wallet. Transactions are authorized by Rapyd or the client, and are subject to Rapyd Protect and compliance rules.</p></section><section dir="ltr" class="section card link" data-origin-id="" data-publication-date="" id="idp281278"><div class="titlepage"><div><div class="title"><h5 class="title"></h5></div></div></div><p class="card-link">en/identity-verification-365089.html</p><p class="icon-container"><span class="icon icon-verify_identity md"></span></p><p class="card-title">Identity Verification</p><p class="card-body">Verification services for onboarding and card issuing.</p></section><section dir="ltr" class="section card link" data-origin-id="" data-publication-date="" id="idp281285"><div class="titlepage"><div><div class="title"><h5 class="title"></h5></div></div></div><p class="card-link">en/rapyd-protect.html</p><p class="icon-container"><span class="icon icon-privacy md"></span></p><p class="card-title">Rapyd Protect</p><p class="card-body">Internal detection and prevention tools for all transactions.</p></section></section></section><section dir="ltr" class="section" data-origin-id="" data-publication-date="" id="idp281292"><div class="titlepage"><div><div class="title"><h3 class="title"></h3></div></div></div><p class="section-title">Developer Resources</p><section dir="ltr" class="section card-container" data-origin-id="" data-publication-date="" id="idp281295"><div class="titlepage"><div><div class="title"><h4 class="title"></h4></div></div></div><section dir="ltr" class="section card link" data-origin-id="" data-publication-date="" id="idp281297"><div class="titlepage"><div><div class="title"><h5 class="title"></h5></div></div></div><p class="card-link">en/information-security.html</p><p class="icon-container"><span class="icon icon-geteway md"></span></p><p class="card-title">Information Security</p><p class="card-body">PCI standards, message security and idempotency.</p></section><section dir="ltr" class="section card link" data-origin-id="" data-publication-date="" id="idp281304"><div class="titlepage"><div><div class="title"><h5 class="title"></h5></div></div></div><p class="card-link">en/authentication.html</p><p class="icon-container"><span class="icon icon-approve_balance md"></span></p><p class="card-title">Authentication</p><p class="card-body">Signatures and header parameters.</p></section><section dir="ltr" class="section card link" data-origin-id="" data-publication-date="" id="idp281311"><div class="titlepage"><div><div class="title"><h5 class="title"></h5></div></div></div><p class="card-link">en/code-samples.html</p><p class="icon-container"><span class="icon icon-developers md"></span></p><p class="card-title">Code Samples</p><p class="card-body">Understanding code samples in Rapyd documentation.</p></section></section><section dir="ltr" class="section card-container" data-origin-id="" data-publication-date="" id="idp281318"><div class="titlepage"><div><div class="title"><h4 class="title"></h4></div></div></div><section dir="ltr" class="section card link" data-origin-id="" data-publication-date="" id="idp281320"><div class="titlepage"><div><div class="title"><h5 class="title"></h5></div></div></div><p class="card-link">en/webhooks.html</p><p class="icon-container"><span class="icon icon-resend md"></span></p><p class="card-title">Webhooks</p><p class="card-body">Callback messages from Rapyd to the client, triggered by internal or external events.</p></section><section dir="ltr" class="section card link" data-origin-id="" data-publication-date="" id="idp281327"><div class="titlepage"><div><div class="title"><h5 class="title"></h5></div></div></div><p class="card-link">en/error-messages.html</p><p class="icon-container"><span class="icon icon-warning_2 md"></span></p><p class="card-title">Error Messages</p><p class="card-body">Error codes and messages relevant to multiple products. List of links to errors for individual products.</p></section><section dir="ltr" class="section card link" data-origin-id="" data-publication-date="" id="idp281334"><div class="titlepage"><div><div class="title"><h5 class="title"></h5></div></div></div><p class="card-link">en/resource-methods.html</p><p class="icon-container"><span class="icon icon-hardrive md"></span></p><p class="card-title">Resource Methods</p><p class="card-body">FX rates, countries, currencies, and POS locations.</p></section></section></section><section dir="ltr" class="section" data-origin-id="" data-publication-date="" id="idp281341"><div class="titlepage"><div><div class="title"><h3 class="title">Resources for Testing in Sandbox</h3></div></div></div><p></p><div class="informaltable list-table table-responsive"><table class="informaltable frame-void rules-rows"><tbody><tr><td class="td"><p class="strong"><a class="xref linktype-component" href="testing-for-payment-api.html" title="Testing for Payment API"><span class="xreftitle">Testing for Payment API</span></a></p></td><td class="td"><p class="body-text">Simulating payments with 3DS. Simulating errors. Simulating Rapyd Verify application responses</p></td></tr><tr><td class="td"><p class="strong"><a class="xref linktype-component" href="testing-for-payout-api.html" title="Testing for Payout API"><span class="xreftitle">Testing for Payout API</span></a></p></td><td class="td"><p class="body-text">Simulating Quarantine Under Review webhook. Bank account numbers for testing.</p></td></tr><tr><td class="td"><p class="strong"><a class="xref linktype-component" href="sandbox-funds.html" title="Sandbox Funds"><span class="xreftitle">Sandbox Funds</span></a></p></td><td class="td"><p class="body-text">Changing the amount of funds in a Rapyd Wallet.</p></td></tr><tr><td class="td"><p class="strong"><a class="xref linktype-component" href="sample-image.html" title="Sample Image"><span class="xreftitle">Sample Image</span></a></p></td><td class="td"><p class="body-text">A sample image for use in methods that require an image.</p></td></tr></tbody></table></div></section></section><div class="footer-content"><div class="section-toc section-toc-after"><div class="section-toc-title">In this section<span class="section-toc-title-delimiter">: </span></div></div><div class="glossary-definitions"></div></div><footer></footer></div></article><article id="search-result-wrapper"><div class="search-container" style="display: none;"><h2>Search results</h2><ul class="searchresults"></ul><p class="noresults">No results found</p></div></article></main><div id="bottom-pager"><ul class="pager"><li class="previous"><a accesskey="p" class="prev pull-left prev visible-lg visible-md" id="header-navigation-prev" href="webhooks.html#UUID-5d2a54d1-e115-fb62-d987-a3d81a8a5d53_UUID-3b9add7e-04a2-f777-4f95-684f23695018">Prev</a></li><li class="next"><a accesskey="n" class="pull-right next visible-lg visible-md" id="header-navigation-next" href="api-reference.html#idp281243">Next</a></li></ul></div><footer class="site-footer"><div class="inner"><div class="copyright"> 漏 2024 </div><div class="publication-date"><span class="publication-date-text">Publication date</span><span class="pubdate-delimiter">: </span><span class="formatted-date"></span></div></div></footer></div></div></div></div></body></html>