Rapyd Docs and API Reference
Documentation
API Reference
Works With Rapyd
Client Portal Guide
Community
Support
Client Login
v148.01
v148.01
stable
Home
Guides & Use Cases
API Reference
Changelog
Home
Guides & Use Cases
Recipes
API Reference
Reference
Changelog
Discussions
Page Not Found
Search
{{ state.current().meta.title }}
API Logs
Home
Guides & Use Cases
API Reference
Changelog
{{search.symbol}}K
discard
Save Edits
Submit
Suggested Edits
Guides
Get Started
Rapyd Platforms
Payment / Payout Method Types
Use Cases
First API Call
Activating Your Account (KYB)
Rapyd Collect
Rapyd Collect Overview
Rapyd Checkout Overview
Hosted Checkout Page Integration Steps
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
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
Modify Payments
Canceling a Payment
Refunds
Partial Refunds
Refund to Multiple Accounts
Refunding More than the Purchase Price
Payment Types Overview
Boleto Bancário
FAST
Giropay
GrabPay
iDEAL
PayNow
PayTM
POLi
SPEI
Trustly
Rapyd Disburse
Rapyd Disburse Overview
Funding Your Client Wallet
Rapyd Disburse Payout Methods
Payout to a Bank Account
ACH Payout
Payout to a Card
Payout to a Local eWallet
Cash Payout
Mass Payouts Overview
Rapyd Disburse Features
Payout with FX
Reusing Beneficiary or Sender
Validating Beneficiary Details
Recurring Payouts
Hosted Beneficiary Account Details Page
Canceling a Payout
Service Providers
Paying Utility Bills
Top-Up Payment
Rapyd Wallet
Rapyd Wallet Overview
Creating a Rapyd Wallet
Identity Verification
Funding a Wallet
Wallet Features
Balances
Moving Funds Between Wallets
Rapyd Issuing
Rapyd Issuing Overview
Cards
Bank Accounts
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
Creating a Financial Operations Ticket
Creating a Compliance Operations Ticket
Viewing Support Tickets
Rapyd Mobile SDKs
SDKs
Guides
Get Started
Rapyd Platforms
Payment / Payout Method Types
Use Cases
First API Call
Activating Your Account (KYB)
Rapyd Collect
Rapyd Collect Overview
Rapyd Checkout Overview
Hosted Checkout Page Integration Steps
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
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
Modify Payments
Canceling a Payment
Refunds
Partial Refunds
Refund to Multiple Accounts
Refunding More than the Purchase Price
Payment Types Overview
Boleto Bancário
FAST
Giropay
GrabPay
iDEAL
PayNow
PayTM
POLi
SPEI
Trustly
Rapyd Disburse
Rapyd Disburse Overview
Funding Your Client Wallet
Rapyd Disburse Payout Methods
Payout to a Bank Account
ACH Payout
Payout to a Card
Payout to a Local eWallet
Cash Payout
Mass Payouts Overview
Rapyd Disburse Features
Payout with FX
Reusing Beneficiary or Sender
Validating Beneficiary Details
Recurring Payouts
Hosted Beneficiary Account Details Page
Canceling a Payout
Service Providers
Paying Utility Bills
Top-Up Payment
Rapyd Wallet
Rapyd Wallet Overview
Creating a Rapyd Wallet
Identity Verification
Funding a Wallet
Wallet Features
Balances
Moving Funds Between Wallets
Rapyd Issuing
Rapyd Issuing Overview
Cards
Bank Accounts
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
Creating a Financial Operations Ticket
Creating a Compliance Operations Ticket
Viewing Support Tickets
Rapyd Mobile SDKs
SDKs
Overview
Rapyd Overview
Rapyd API Reference
Rapyd API Reference Guide
Rapyd Platform
Code Samples
Information Security
Message Security
Idempotency
Request Signatures
Webhooks
Webhook Format
Webhook Security
Webhook Signatures
List of Webhooks
Error Messages
General Errors
File Errors
Foreign Exchange Errors
Hosted Page Errors
Rapyd Collect
Rapyd Collect Overview
Payment Object
Payment Fees Object
Outcome Object
Wallets Array
Bank Redirect Payment Message Sequences
Bank Transfer Payment Message Sequences
Cash 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 Object
Group Payments
post
Create Group Payment
get
Retrieve Group Payment
delete
Cancel Group Payment
post
Create Group Refund
Webhook - Group Payment Completed
Group Payment Errors
Escrow Object
Escrows
get
Retrieve Escrow
post
Release Funds from Escrow
get
List Escrow Releases
Webhook - Escrow Released
Escrow Errors
Refund Object
Refunds
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
Customer Object
Customers
post
Create Customer
post
Update Customer
get
List Customers
get
Retrieve Customer
delete
Delete Customer
delete
Delete Discount from Customer
Customer Errors
Address Object
Addresses
post
Create Address
post
Update Address
get
Retrieve Address
Address Errors
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
Customer Payment Method Errors
Payment Method Type Object
get
List Payment Methods by Country
get
Get Payment Method Required Fields
Payment Method Errors
Tokens
Bank Account Token Object
Card Token Object
PII Token Object
post
Create Token
post
Create Card Token - Hosted Page
get
Retrieve a Token
Token Errors
Product Object - Collect
post
Create Product
post
Update Product
get
Retrieve Product
get
List Products
delete
Delete Product
Product Errors
SKU Object
post
Create SKU
post
Update SKU
get
Retrieve SKU
get
List SKUs
delete
Delete SKU
SKU Errors
Plan Object - Collect
Pricing Plans
post
Create Plan
post
Update Plan
get
Retrieve Plan
get
List Plans
delete
Delete Plan
Plan Errors
Subscription Object - Collect
Billing Period Calculations
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
Subscription Errors
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 Record Object
post
Create Usage Record
get
List Usage Records
Usage Record Errors
Coupon Object
post
Create Coupon
post
Update Coupon
get
Retrieve Coupon
get
List Coupons
delete
Delete Coupon
Coupon Errors
Discount Object
Order Object
post
Create an Order
post
Update Order
post
Pay an Order
get
Retrieve an Order
get
List Orders
Order Errors
Return Object
post
Create a Return Against an Order
get
Retrieve a Return
get
List Returns
Return Errors
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
List Invoices
delete
Delete Invoice
Webhook - Invoice Payment Succeeded
Invoice Errors
Invoice Item Object
post
Create Invoice Item
post
Update Invoice Item
get
Retrieve Invoice Item
get
List Invoice Items
delete
Delete Invoice Item
Invoice Item Errors
Checkout Page Object
Custom Elements Object
Determining Payment Methods
post
Create Checkout Page
Sample Checkout Pages
get
Retrieve Checkout Page
Checkout Errors
Rapyd Protect Errors - Rapyd Authorization
Rapyd Disburse
Rapyd Disburse Overview
Payout Object
Payout to Card Message Sequences
Payout to Bank Message Sequences
Payout to Cash Message Sequences
post
Create Payout
post
Confirm Payout with FX
post
Complete Payout
get
Retrieve Payout
delete
Cancel Payout
get
List Payouts
Webhook - Payout Completed
Webhook - Payout Expired
Webhook - Payout Failed
Webhook - Payout Returned
Payout Errors
Payout Method Type Object
get
List Payout Method Types
get
Get Payout Required Fields
Sender Object
post
Create Sender
get
Retrieve Sender
delete
Delete Sender
Beneficiary Object
post
Create Beneficiary
post
Validate Beneficiary
get
Retrieve Beneficiary
delete
Delete Beneficiary
Additional Sender and Beneficiary Fields
Beneficiary Tokenization Page Object
post
Create Beneficiary Tokenization Page
get
Retrieve Beneficiary ID
Beneficiary Tokenization Errors
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
Plan Object - Disburse
Create Plan - Disburse
Product Object - Disburse
Create Product - Disburse
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
Wallet Object
post
Create Wallet
put
Update Wallet
put
Disable Wallet
put
Enable Wallet
get
Retrieve Wallet
delete
Delete Wallet
Wallet Errors
Wallet Contact Object
post
Add Contact to Wallet
post
Update Wallet Contact
get
Retrieve Wallet Contact
get
List Contacts for a Rapyd Wallet
delete
Delete Wallet Contact
Wallet Contact Errors
Wallet Transaction Object
Wallet Limit Object
Action Data Object
Transaction Types
Wallet Balance Types
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 Funds Between Wallets Created
Webhook - Transfer Funds Between Wallets Response
Webhook - Transfer Request
Webhook - Transfer Completed
Wallet Transaction Errors
Identity Verification Object
post
Create Identity Verification Page
get
List Official Identification Documents
post
Verify Identity
Webhook - Identity Verification
Identity Verification Errors
Rapyd Issuing
Rapyd Issuing Overview
Issued Card Object
post
Issue Card
post
Activate Issued Card
post
Update Card Status
post
Set PIN Code
post
Personalize Issued Card
get
List Issued Cards
get
Retrieve Issued Card Details
post
Simulate Blocking a Card
Webhook - Card Issuing Blocked
Card Details Object
post
Display Issued Card Details to Customer
Rapyd Authorization Object
post
Simulate a Card Adjustment
post
Simulate a Card Refund
Webhook - Card Issuing Adjustment
Webhook - Card Issuing Refund
Webhook - Card Issuing Reversal
Webhook - Card Issuing Sale
Rapyd Authorization Errors
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 Transaction Object
get
List Issued Card Transactions
get
Retrieve Issued Card Transaction Details
Issued Bank Account Number Object
post
Issue Bank Account Number to Wallet
post
Simulate a Bank Transfer to a Wallet
get
Retrieve Bank Account History for Wallet
get
Retrieve Bank Account Transaction from Wallet
Webhook - Deposit Completed
Issuing Platform Errors
Metadata
Metadata Object
Metadata Errors
Resource Methods
Resource Methods
Country Object
get
List Countries
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 Payments API
Card Numbers for Testing
Error Simulation
Simulated Errors
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
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
Use Paycode
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