Rapyd Docs and API Reference
Docs
API Reference
Changelog
Plugins
Client Portal Guide
Developer Forums
Support
Client Login
v181.02
v181.02
stable
Home
Guides
API Reference
Changelog
Home
Guides
Recipes
API Reference
Reference
Changelog
Discussions
Page Not Found
Search
{{ state.current().meta.title }}
API Logs
Home
Guides
API Reference
Changelog
{{search.symbol}}K
discard
Save Edits
Submit
Suggested Edits
Rapyd Docs
Get Started
Rapyd Platforms
Payment / Payout Method Types
Use Cases
First API Call
Activating Your Account (KYB)
Developer Champions
Postman Collection
YouTube Tutorials
Rapyd Code Samples
Rapyd Collect
Rapyd Collect Overview
Rapyd Checkout Overview
Hosted Checkout Page Integration
Checkout Toolkit Integration
Complete Payment
Save Card Details With Rapyd Checkout
Integrate Payment Methods
Card Payments
Card Payment With 3DS Verification
Card on File
Card on File With 3DS Verification
Card to Card Payments
Bank Direct Debit
Bank Transfers
Bank Redirect
Cash Payments
eWallets
Billing
Subscriptions
Mass Invoices
Payment Features
Two-Step Payment
Payment With FX
Split Payment by Amount
Group Payments
Escrow
Canceling an Escrow
Partial Payments
Virtual Account Numbers
Modify Payments
Canceling a Payment
Refunds
Partial Refunds
Refund to Multiple Accounts
Payment Method Types
Payment Types Overview
Americas
Boleto Bancário
Cash Collection El Salvador
Cash Payments Dominican Republic
Cash Payment MX
SPEI
Pix
APAC
Alipay
BancNet
CIMB Bank
DANA
FAST
GCash
GrabPay
KakaoPay
LinkAja
Maybank
OVO
Payco
PayNow
PayTM
PhonePe
POLi
PromptPay
UPI
UnionPay
QRIS
Samsung Pay
TrueMoney
EMEA
Apple Pay
Giropay
Google Pay™
iDEAL
Trustly
Pagaqui
Paysafecard
SEPA Direct Debit
Global
Visa
Mastercard
Rapyd Disburse
Rapyd Disburse Overview
Funding Your Client Wallet
Mass Payouts Overview
Rapyd Disburse Features
Payout With FX
Reusing Beneficiary or Sender
Validating Beneficiary Details
Recurring Payouts
Beneficiary Account Details
Canceling a Payout
Service Providers
Paying Utility Bills
Top-Up Payment
Payout Method Types
Rapyd Disburse Payout Methods
Payout to a Bank Account
ACH Payout
Payout to a Card
Cash Payout
Rapyd Wallet
Rapyd Wallet Overview
Wallet Contact
Creating a Rapyd Wallet
Identity Verification
Hosted IDV Page and Toolkit
Funding a Wallet
Wallet Features
Balances
Moving Funds Between Wallets
Rapyd Verify Hosted Page
Rapyd Issuing
Rapyd Issuing Overview
Cards
Issued Card Activation
Hosted Issued Card Page - Reset PIN
Hosted Page for Virtual Cards
Authorization
Load and Spend Authorization
Remote Authorization
Setting Up a Remote Authorization Server
Authorizing a Card Transaction Remotely
Rapyd Point of Sale
Point-of-Sale Locations
Withdrawing Cash
Reversing a Withdrawal
Depositing Cash to Wallet
Client Support
Client Support
Creating a Customer Support Ticket
Viewing Support Tickets
Rapyd Docs
Get Started
Rapyd Platforms
Payment / Payout Method Types
Use Cases
First API Call
Activating Your Account (KYB)
Developer Champions
Postman Collection
YouTube Tutorials
Rapyd Code Samples
Rapyd Collect
Rapyd Collect Overview
Rapyd Checkout Overview
Hosted Checkout Page Integration
Checkout Toolkit Integration
Complete Payment
Save Card Details With Rapyd Checkout
Integrate Payment Methods
Card Payments
Card Payment With 3DS Verification
Card on File
Card on File With 3DS Verification
Card to Card Payments
Bank Direct Debit
Bank Transfers
Bank Redirect
Cash Payments
eWallets
Billing
Subscriptions
Mass Invoices
Payment Features
Two-Step Payment
Payment With FX
Split Payment by Amount
Group Payments
Escrow
Canceling an Escrow
Partial Payments
Virtual Account Numbers
Modify Payments
Canceling a Payment
Refunds
Partial Refunds
Refund to Multiple Accounts
Payment Method Types
Payment Types Overview
Americas
Boleto Bancário
Cash Collection El Salvador
Cash Payments Dominican Republic
Cash Payment MX
SPEI
Pix
APAC
Alipay
BancNet
CIMB Bank
DANA
FAST
GCash
GrabPay
KakaoPay
LinkAja
Maybank
OVO
Payco
PayNow
PayTM
PhonePe
POLi
PromptPay
UPI
UnionPay
QRIS
Samsung Pay
TrueMoney
EMEA
Apple Pay
Giropay
Google Pay™
iDEAL
Trustly
Pagaqui
Paysafecard
SEPA Direct Debit
Global
Visa
Mastercard
Rapyd Disburse
Rapyd Disburse Overview
Funding Your Client Wallet
Mass Payouts Overview
Rapyd Disburse Features
Payout With FX
Reusing Beneficiary or Sender
Validating Beneficiary Details
Recurring Payouts
Beneficiary Account Details
Canceling a Payout
Service Providers
Paying Utility Bills
Top-Up Payment
Payout Method Types
Rapyd Disburse Payout Methods
Payout to a Bank Account
ACH Payout
Payout to a Card
Cash Payout
Rapyd Wallet
Rapyd Wallet Overview
Wallet Contact
Creating a Rapyd Wallet
Identity Verification
Hosted IDV Page and Toolkit
Funding a Wallet
Wallet Features
Balances
Moving Funds Between Wallets
Rapyd Verify Hosted Page
Rapyd Issuing
Rapyd Issuing Overview
Cards
Issued Card Activation
Hosted Issued Card Page - Reset PIN
Hosted Page for Virtual Cards
Authorization
Load and Spend Authorization
Remote Authorization
Setting Up a Remote Authorization Server
Authorizing a Card Transaction Remotely
Rapyd Point of Sale
Point-of-Sale Locations
Withdrawing Cash
Reversing a Withdrawal
Depositing Cash to Wallet
Client Support
Client Support
Creating a Customer Support Ticket
Viewing Support Tickets
Rapyd API Reference
API Reference
Rapyd Overview
Rapyd Platform
Code Samples
Authentication
Header Parameters
Request Signatures
Webhook Authentication
Information Security
REST Message Security
Idempotency
Webhooks
Webhook Format
Webhook Security
Error Messages
General Errors
File Errors
Card Network Error Messages
Bank Transfer Error Messages
Card Transaction Errors
Foreign Exchange Errors
Hosted Page Errors
Hosted Page Language Support
get
List Hosted Page Supported Languages
Rapyd Protect
Quarantine Object
Webhook - Quarantine Under Review
Webhook - Quarantine Declined
Webhook - Quarantine Released
Webhook - Quarantine Release Failed
Rapyd Protect Errors - Rapyd Authorization
Rapyd Protect Errors - Remote Authorization
Rapyd Collect
Rapyd Collect Overview
Payments
Payment Object
Client Details Object
Outcome Object
Payment Fees Object
Payment Method Data Object
Wallets Array
Creating a Split Payment
Creating a Card Payment With 3DS Authentication
Creating a Payment Using Customer Profile Information
Customizing Hosted Pages with Google Pay
Creating a Google Pay Payment on a Customized Checkout Page
Customizing Hosted Pages with Apple Pay
Creating an Apple Pay Payment on a Customized Checkout Page
Creating a Payment with Apple Pay
Card Payment Message Sequences
Card Payment With Delayed Capture Message Sequences
Cash Payment Message Sequences
Bank Redirect Payment Message Sequences
Bank Transfer Payment Message Sequences
post
Create Payment
post
Update Payment
post
Capture Payment
post
Complete Payment
get
Retrieve Payment
delete
Cancel Payment
get
List Payments
Webhook - Payment Captured
Webhook - Payment Completed
Webhook - Payment Expired
Webhook - Payment Failed
Webhook - Payment Reversed
Payment Errors
Group Payment
Group Payment Object
Creating a Group Payment
post
Create Group Payment
get
Retrieve Group Payment
delete
Cancel Group Payment
post
Create Group Refund
Webhook - Group Payment Completed
Group Payment Errors
Digital Wallets
Digital Wallet Object
post
Retrieve Apple Pay Session
Escrows
Escrow Object
Creating a Payment with Escrow
Releasing Funds from Escrow
get
Retrieve Escrow
post
Release Funds from Escrow
get
List Escrow Releases
Webhook - Escrow Released
Escrow Errors
Refunds
Refund Object
Creating a Refund
Refund Message Sequences
post
Create Refund
post
Update Refund
post
Complete Refund
get
Retrieve Refund
get
List Refunds
get
List Refunds by Payment ID
Webhook - Refund Completed
Webhook - Refund Rejected
Refund Errors
Disputes
Dispute Object
SEPA Bank Transfer Dispute Message Sequence
get
Retrieve Dispute
get
List Disputes
Webhook - Dispute Created
Webhook - Dispute Updated
Customers
Customer Object
post
Create Customer
post
Update Customer
get
List Customers
get
Retrieve Customer
delete
Delete Customer
delete
Delete Discount from Customer
Webhook - Customer Created
Webhook - Customer Updated
Webhook - Customer Deleted
Customer Errors
Addresses
Address Object
post
Create Address
post
Update Address
get
Retrieve Address
Address Errors
Payment Method Types
Payment Method Type Object
Options Objects
Payment Options Object
Payment Method Options Object
Conditions Object
Operators for Conditions
Conditions - Examples
get
List Payment Methods by Country
get
Get Payment Method Required Fields
Payment Method Errors
Customer Payment Methods
Customer Payment Method Object
Add Payment Method Sequence
post
Add Payment Method to Customer
post
Update Payment Method
get
Retrieve Payment Method
get
List Payment Methods of Customer
delete
Delete Payment Method
Webhook - Payment Method Canceled
Webhook - Payment Method Failed
Webhook - Card Added Failure
Webhook - Customer Payment Method Created
Customer Payment Method Errors
Card Tokens
Hosted Page Card Token Object
post
Create Card Token - Hosted Page
Sample Page for Saving Card Details
Hosted Page Token Errors
Products - Collect
Product Object - Collect
post
Create Product
post
Update Product
get
Retrieve Product
get
List Products
delete
Delete Product
Product Errors
SKUs
SKU Object
post
Create SKU
post
Update SKU
get
Retrieve SKU
get
List SKUs
delete
Delete SKU
SKU Errors
Plans - Collect
Pricing Plans
Plan Object - Collect
post
Create Plan
post
Update Plan
get
Retrieve Plan
get
List Plans
delete
Delete Plan
Plan Errors
Subscriptions - Collect
Billing Period Calculations
Subscription Object - Collect
post
Create Subscription
post
Update Subscription
post
Complete a Cycle
post
Start a New Cycle
get
Retrieve Subscription
get
List Subscriptions
delete
Cancel Subscription
delete
Delete Discount from Subscription
Webhook - New Cycle Started - Collect
Webhook - Subscription Updated - Collect
Webhook - Subscription Unpaid - Collect
Webhook - Subscription Canceled - Collect
Subscription Errors
Subscription Items - Collect
Subscription Item Object - Collect
post
Create Subscription Item
post
Update Subscription Item
get
Retrieve Subscription Item
get
List Subscription Items
delete
Delete Subscription Item
Subscription Item Errors
Usage Records
Usage Record Object
post
Create Usage Record
get
List Usage Records
Usage Record Errors
Coupons
Coupon Object
post
Create Coupon
post
Update Coupon
get
Retrieve Coupon
get
List Coupons
delete
Delete Coupon
Coupon Errors
Discounts
Discount Object
get
Retrieve Discount - Customer
get
Retrieve Discount - Subscription
Orders
Order Object
post
Create an Order
post
Update Order
post
Pay an Order
get
Retrieve an Order
get
List Orders
Webhook - Order Payment Failed
Webhook - Order Updated
Order Errors
Returns
Return Object
post
Create a Return Against an Order
get
Retrieve a Return
get
List Returns
Return Errors
Invoices
Invoice Object
post
Create Invoice
post
Update Invoice
post
Finalize Invoice
post
Pay Invoice
post
Void Invoice
post
Mark Invoice Uncollectible
get
Retrieve Invoice
get
Retrieve Invoice Lines from Invoice
get
Retrieve Upcoming Invoice
get
Retrieve Invoice Lines from Upcoming Invoice
get
Retrieve Invoice Item
get
List Invoices
delete
Delete Invoice
Webhook - Invoice Created
Webhook - Invoice Updated
Webhook - Invoice Finalized
Webhook - Invoice Payment Created
Webhook - Invoice Payment Succeeded
Webhook - Invoice Payment Failed
Invoice Errors
Invoice Items
Invoice Item Object
post
Create Invoice Item
post
Update Invoice Item
get
List Invoice Items
delete
Delete Invoice Item
Invoice Item Errors
Checkout Page
Checkout Page Object
Custom Elements Object
Configuring List of Payment Methods
Sample Checkout Pages
post
Create Checkout Page
get
Retrieve Checkout Page
Checkout Errors
Rapyd Disburse
Rapyd Disburse Overview
Payouts
Payout Object
Payout Fees Object
Payout to Card Message Sequences
Payout to Bank Message Sequences
Payout to Cash Message Sequences
Payout With FX Message Sequences
post
Create Payout
post
Confirm Payout with FX
post
Set Payout Response
post
Update Payout
post
Complete Payout
get
Retrieve Payout
delete
Cancel Payout
get
List Payouts
Webhook - Payout Completed
Webhook - Payout Expired
Webhook - Payout Failed
Webhook - Payout Returned
Webhook - Payout Updated
Payout Errors
Payout Method Types
Payout Method Type Object
Payout Options Object
get
List Payout Method Types
get
Get Payout Required Fields
Senders
Sender Object
post
Create Sender
get
Retrieve Sender
delete
Delete Sender
Beneficiaries
Beneficiary Object
post
Create Beneficiary
post
Validate Beneficiary
get
Retrieve Beneficiary
delete
Delete Beneficiary
Additional Sender and Beneficiary Fields
Beneficiary Tokens
Beneficiary Tokenization Page Object
Beneficiary Optional Fields Object
post
Create Beneficiary Tokenization Page
Sample Beneficiary Tokenization Pages
Webhook - Beneficiary Created
Beneficiary Tokenization Errors
Subscriptions - Disburse
Subscription Object - Disburse
post
Create Subscription - Disburse
post
Update Subscription - Disburse
get
Retrieve Subscription - Disburse
get
List Subscriptions - Disburse
delete
Cancel Subscription - Disburse
Payout Subscription Errors
Plans - Disburse
Plan Object - Disburse
Create Plan - Disburse
Products - Disburse
Product Object - Disburse
Create Product - Disburse
Service Providers
Service Provider Object
get
List Service Providers
get
Retrieve Service Provider Details
post
Validate Service Provider Account
post
Pay Service Provider
post
Check Consumer Account Balance
Webhook - Service Provider Payment Completed
Service Provider Errors
Rapyd Wallet
Rapyd Wallet Overview
Wallets
Wallet Object
post
Create Wallet
put
Update Wallet
put
Disable Wallet
put
Enable Wallet
get
Retrieve Wallet
get
List Wallets
delete
Delete Wallet
Webhook - Wallet Enabled
Webhook - Wallet Disabled
Webhook - Wallet Deleted
Wallet Errors
Wallet Contacts
Wallet Contact Object
Business Details Object
post
Add Contact to Wallet
post
Update Wallet Contact
get
Retrieve Wallet Contact
get
List Contacts for a Rapyd Wallet
get
Retrieve Compliance Profile of Contact
delete
Delete Wallet Contact
Wallet Contact Errors
Wallet Transactions
Transaction Types
Wallet Balance Types
Wallet Transaction Object
Wallet Limit Object
Action Data Object
post
Transfer Funds Between Wallets
post
Set Transfer Response
post
Put Funds on Hold
post
Release On-Hold Funds
post
Set Wallet Account Limit
delete
Delete Wallet Account Limit
get
List Wallet Transactions
get
Retrieve Wallet Balances
get
Get Details of Wallet Transaction
Webhook - Funds Added
Webhook - Funds Removed
Webhook - Transfer Completed
Webhook - Transfer Funds Between Wallets Created
Webhook - Transfer Funds Between Wallets Response
Webhook - Transfer Request
Wallet Transaction Errors
Transaction Limits
Transaction Limit Object
Webhook - Transaction Limit Changes - Beta
Identity Verification
Identity Verification Object
post
Verify Identity
get
List Official Identification Documents
Webhook - Identity Verification
Identity Verification Errors
Hosted Page Identity Verification
Hosted Page Identity Verification Object
Sample Hosted Identity Verification Page
post
Create Identity Verification Page
Hosted Page Identity Verification Errors
Virtual Accounts
Virtual Account Number Object
post
Issue Virtual Account Number to Wallet
post
Simulate a Bank Transfer to a Wallet
get
List Capabilities of Virtual Accounts per Country
get
Retrieve Virtual Account History
get
Retrieve Virtual Account Transaction
get
List Virtual Accounts by Rapyd Wallet
get
Retrieve Remitter Details
Webhook - Deposit Completed
Virtual Account Number Errors
Rapyd Verify
Rapyd Verify Object
Merchant Details Object
Organization Details Object
Rapyd Verify Hosted Page Images
post
Create Hosted Application
get
List Application Types by Country
get
Retrieve Application
get
Retrieve Application Status
Filling Out a Hosted Application - Sole Proprietor
Filling Out a Hosted Application - Company
Webhook - Application Status Change
Rapyd Issuing
Rapyd Issuing Overview
Issued Card
Issued Card Object
post
Issue Card
post
Activate Issued Card Using API
post
Update Card Status
post
Set PIN Code
post
Personalize Bulk-Issued Card
get
List Issued Cards
get
Retrieve Issued Card Details
post
Simulate Blocking a Card
Webhook - Bulk-Issued Card Personalized
Webhook - Issued Card Activated
Webhook - Issued Card PIN Set
Webhook - Card Issuing Blocked
Issued Card Errors
Card Details
Card Details Object
post
Display Issued Card Details to Customer
Rapyd Authorization
Rapyd Authorization Object
post
Simulate a Card Adjustment
post
Simulate a Card Refund
Webhook - Authorization Declined
Webhook - Card Issuing Adjustment
Webhook - Card Issuing Refund
Webhook - Card Issuing Reversal
Webhook - Card Issuing Sale
Webhook - Deposit Completed
Rapyd Authorization Errors
Remote Authorization
Remote Authorization Object
post
Simulate a Card Authorization Request
post
Simulate a Card Authorization Reversal
Webhook - Remote Authorization Successful
Webhook - Remote Authorization Reversed
Issued Card Transactions
Issued Card Transaction Object
get
List Issued Card Transactions
get
Retrieve Issued Card Transaction Details
Hosted Card Activation Page
Hosted Card Activation Page Object
post
Activate Issued Card Using Hosted Page
Sample Pages for Activating Issued Card
post
Reset PIN Code Using Hosted Page
Metadata
Metadata Object
Metadata Errors
Resource Methods
Resource Methods
Country Object
get
List Countries
Daily Rates
Daily Rate Object
get
Get Daily Rate
Currency Object
get
List Currencies
Location Object
get
Retrieve Rapyd POS Location
get
List Rapyd POS Locations
get
List Rapyd POS Locations by Coordinates
get
List Rapyd POS Locations by Coordinates - Cluster-Based
Location Errors
Testing
Testing for Payment API
Card Numbers for Testing
Error Simulation
Simulated Errors
Simulating 3DS Authentication
Simulating 3DS Authentication - API Method
Simulating 3DS Authentication - Hosted Page
Simulating Cardholder Disputes
Simulating Hosted Application Responses
Add Funds and Remove Funds Transactions
post
Add Funds to Wallet Account
post
Remove Funds From Wallet Account
get
Get Details of Add Funds Request
get
Get Details of Remove Funds Request
Testing for Payout API
BIC/SWIFT Numbers for Testing
IBAN Numbers for Testing
Sample Image
Point-of-Sale API
Point-of-Sale API Overview
Sessions
post
Open Session
post
Close Session
get
Echo the Platform
Deposit and Pay
post
Deposit
get
Pay
post
Use Paycode
get
Get Paycode Details
Webhook - Payment Completion
Webhook - Payment Confirmation
Webhook - Deposit Confirmation
Webhook - Deposit Completed
Withdrawal
post
Withdraw
post
Reverse Withdrawal
Webhook - Withdraw Completed
Webhook - Withdraw Reversal
Glossary
Glossary