Rapyd API
This is a release of the OpenAPI specification for Rapyd's API methods. It is recommended to initially run the methods in the sandbox environment. For the…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
This is a release of the OpenAPI specification for Rapyd's API methods. It is recommended to initially run the methods in the sandbox environment. For the most up-to-date documentation of Rapyd's methods, see the online API Reference. For required signature, see Request Signatures.
Endpoints 203
Payment Method Type
- GETList Payment Methods by Country
/v1/payment_methods/countries/:countryIdRetrieve a list of all payment methods available for a country. You fdn filter the results by specifying the currency query parameter. - GETGet Payment Method Required Fields
/v1/payment_methods/:type/required_fieldsRetrieve the required fields for a payment method. The fields are returned as a list of objects. The name of each field appears in the name field of the…
Payment
- GETList Payments
/v1/paymentsRetrieve a list of all payments that you have created. Filter the list with query parameters. - POSTCreate Payment
/v1/paymentsCreate a payment - GETRetrieve Payment
/v1/payments/:paymentIdRetrieve details of a payment - POSTUpdate Payment
/v1/payments/:paymentIdCapture some or all of a card payment that was previously authorized with capture set to false.<BR>This method changes the payment object status to CLO and… - DELETECancel Payment
/v1/payments/:paymentIdCancel a payment where the status of the payment is ACT. Relevant to payment methods where is_cancelable = true in the response to List Payment Methods by… - POSTCapture Payment
/v1/payments/:paymentId/captureCapture some or all of a card payment that was previously authorized with capture set to false.<BR>This method changes the payment object status to CLO and… - POSTComplete Payment
/v1/payments/completePaymentTo simulate the completion of a payment by the action of a third party, use this method in the sandbox.<BR> This method changes the payment status to CLO…
Checkout Page
- GETRetrieve Checkout Page
/v1/checkout/:checkout_tokenRetrieve a checkout page. - POSTCreate Checkout Page
/v1/checkoutCreate a checkout page that makes a payment.
Subscription
- GETList Subscriptions
/v1/payments/subscriptionsRetrieve a list of subscriptions. You can filter the list with query parameters. - POSTCreate Subscription
/v1/payments/subscriptionsCreate a subscription for regular, automatic payments. - GETRetrieve Subscription
/v1/payments/subscriptions/:subscriptionIdRetrieve the details of a subscription. - POSTUpdate Subscription
/v1/payments/subscriptions/:subscriptionIdUpdate the details of a subscription. - DELETECancel Subscription
/v1/payments/subscriptions/:subscriptionIdCancel a subscription. - DELETEDelete Discount from Subscription
/v1/payments/subscriptions/:subscriptionId/discountDelete the discount that was assigned to a subscription. This method does not affect the coupon that the discount was derived from. - POSTCreate Subscription by Hosted Page
/v1/checkout/subscriptionsCreate a subscription using a hosted page. Relevant to card payments. - GETRetrieve Discount of Subscription
/v1/subscriptions/discount/:discountIdRetrieve a discount for a subscription.
Subscription.Product
- GETList Products
/v1/productsRetrieve a list of all products. - POSTCreate Product
/v1/productsCreate goods or services. - GETRetrieve Product
/v1/products/:productsIdRetrieve details of a product or service. - POSTUpdate Product
/v1/products/:productsIdChange or modify a product or service. - DELETEDelete Product
/v1/products/:productsIdDelete a product or service from the Rapyd platform. This action also deletes all associated plans.
Subscription.Plan
- GETList Plans
/v1/plansRetrieve a list of all plans. Use the optional query parameters to filter the results. You can filter the results further by specifying one or more Plan… - POSTCreate Plan
/v1/plansCreate a pricing plan for services. - GETRetrieve Plan
/v1/plans/:planIdRetrieve the details of a pricing plan for services. - POSTUpdate Plan
/v1/plans/:planIdChange or modify a pricing plan for services. You can update a plan's nickname or metadata. - DELETEDelete Plan
/v1/plans/:planIdDelete a pricing plan for services.
Subscription.Subscription Item
- GETList Subscription Items
/v1/subscription_items?subscription=sub_0de9c79c1e2beee09499dc8220493d59Retrieve a list of all subscription items for a subscription. - POSTCreate Subscription Item
/v1/subscription_itemsCreate a subscription item and add it to an existing subscription for recurring payment. - GETRetrieve Subscription Item
/v1/subscription_items/:subscriptionItemIdRetrieve the details of a subscription item. - POSTUpdate Subscription Item
/v1/subscription_items/:subscriptionItemIdChange or modify a subscription item. - DELETEDelete Subscription Item
/v1/subscription_items/:subscriptionItemIdDelete a subscription item from the Rapyd platform. - GETList Usage Records
/v1/subscription_items/:subscriptionItemId/usage_record_summariesRetrieve a list of usage records for a subscription item - POSTCreate Usage Record
/v1/subscription_items/:subscriptionItemId/usage_recordsCreate a usage record or update an existing usage record where its unique identifier is composed of timestamp and subscription_item
Subscription.Invoice
- GETList Invoices
/v1/invoicesRetrieve a list of all invoices that you have created. You can filter the list with query parameters. - POSTCreate Invoice
/v1/invoicesCreate an invoice to add a one-time charge to a subscription.<BR>After you create the invoice with this method, create invoice items and assign them to the… - GETRetrieve Invoice
/v1/invoices/:invoiceIdRetrieve the basic data of an invoice, with individual invoice lines. - POSTUpdate Invoice
/v1/invoices/:invoiceIdChange or modify an invoice. You can modify the invoice when its status is draft. - DELETEDelete Invoice
/v1/invoices/:invoiceIdDelete an invoice. You can delete an invoice when status is draft. - POSTVoid Invoice
/v1/invoices/:invoiceId/voidSet an invoice to void status. <BR> Void invoices are similar to deleted invoices, but their records are kept for accounting purposes. - POSTFinalize Invoice
/v1/invoices/:invoiceId/finalizeFinalize an invoice. Invoices are initially created with a draft status, and this is the only state in which an invoice can be finalized. <BR>When an invoice… - POSTPay Invoice
/v1/invoices/:invoiceId/payMake a payment against an invoice. - POSTMark Invoice Uncollectible
/v1/invoices/:invoiceId/mark_uncollectibleSet an invoice to uncollectible status. <BR> This status indicates that the invoice cannot be paid by the customer. - GETRetrieve Invoice Lines from Invoice
/v1/invoices/:invoiceId/linesRetrieve invoice lines from an invoice. <BR>Invoice lines are subscription items or invoice items. - GETRetrieve Upcoming Invoice
/v1/invoices/upcoming?customer=cus_4ed89a9c556fb200997e974f75895dc9Retrieve a preview of the basic data of the upcoming invoice for a customer, with individual invoice lines.<BR> To get the invoice lines of the invoice, use… - GETRetrieve Invoice Lines from Upcoming Invoice
/v1/invoices/upcoming/lines?customer=cus_4ed89a9c556fb200997e974f75895dc9Retrieve invoice lines from the upcoming invoice for a customer. <BR> If a customer has more than one subscription, this method retrieves the invoice lines of…
Subscription.Invoice Item
- GETList Invoice Items
/v1/invoice_itemsRetrieve a list of all invoice items. <BR> You can filter the list with query parameters. - POSTCreate Invoice Item
/v1/invoice_itemsCreate an invoice item and add it to an invoice or subscription.<BR>Note: If you create an invoice item without specifying the invoice ID or subscription ID,… - GETRetrieve Invoice Item
/v1/invoice_items/:invoiceItemRetrieve the details of an invoice item. - POSTUpdate Invoice Item
/v1/invoice_items/:invoiceItemChange or modify an invoice item.<BR> You can update an invoice item at any time before the corresponding subscription generates an invoice.<BR> This method… - DELETEDelete Invoice Item
/v1/invoice_items/:invoiceItemDelete an invoice item from the upcoming invoice.<BR> Use this method in the following situations:<BR> * The invoice item is attached to an invoice.<BR> * The…
Payment Link
- GETGet Payment Link
/v1/hosted/collect/payments/:paymentLinkRetrieve details of a payment link. - POSTCreate Payment Link
/v1/hosted/collect/payments/Creates a reusable link for a hosted payment page. <BR> A customer can use the link and the hosted payment page multiple times. After providing required…
Payment.Card Token
- POSTCreate Card Token
/v1/hosted/collect/card/Create a hosted page for a customer to save card details and manage cards. Prerequisite: Create Customer.
Group Payment
- POSTCreate Group Payment
/v1/payments/group_paymentsCreate Group Payment - GETRetrieve Group Payment Details
/v1/payments/group_payments/:groupPaymentIdRetrieve details of a group payment. - DELETECancel Group Payment
/v1/payments/group_payments/:groupPaymentIdCancel a group payment.
Escrow
- GETList Escrow Releases
/v1/payments/:payment/escrows/:escrow/escrow_releasesRetrieve a list of all releases of funds from a specified escrow. - POSTRelease Funds from Escrow
/v1/payments/:payment/escrows/:escrow/escrow_releasesRetrieve a list of all releases of funds from a specified escrow. - GETRetrieve Escrow
/v1/payments/:payment/escrows/:escrowRetrieve details of the escrow for a payment.
Refund
- GETList Refunds
/v1/refundsRetrieve a list of all refunds. - POSTCreate Refund
/v1/refundsRefund of a payment. The refund is credited against a specific payment. The money is returned to the payment method that was used for the payment, and the… - POSTComplete Refund
/v1/refunds/completeSimulate the action of a third party that is required for completing the refund process. Relevant to sandbox. Use this method when a payment was made with a… - POSTCreate Group Refund
/v1/refunds/group_paymentsRefund a group payment when the status of the group payment is closed. The refund is credited against a specific group payment. The money is returned to the… - GETRetrieve Refund
/v1/refunds/:refundIdRetrieve the details of a refund object. - POSTUpdate Refund
/v1/refunds/:refundIdChange or modify the metadata in a refund object.
Digital Wallet
- POSTRetrieve Apple Pay Session
/v1/digital_wallets/session/apple_payRetrieve the details of an Apple Pay payment session. Each payment that uses Apple Pay has a unique session. Activating Apple Pay is a prerequisite.
Dispute
- GETList Disputes
/v1/disputesRetrieve a detailed list of 'dispute' objects. - GETRetrieve Dispute
/v1/disputes/:disputeIdRetrieve the details of a dispute.
Customer
- GETList Customers
/v1/customersRetrieve a list of all customers - POSTCreate Customer
/v1/customersAdds a customer to the client. - GETRetrieve Customer Details
/v1/customers/:customerIdRetrieve a customer. - POSTUpdate Customer
/v1/customers/:customerIdUpdate a customer with customer Id in Path - DELETEDelete Customer
/v1/customers/:customerIdThis method triggers the Customer Deleted webhook. This webhook contains the same information as the response - GETRetrieve Discount of Customer
/v1/customers/discount/:discountIdRetrieve a discount for a customer. - DELETEDelete Discount from Customer
/v1/customers/:customerId/discountDelete the discount that has been assigned to a customer through a coupon. This action does not affect the coupon that the discount was derived from. This…
Payment.Address
- POSTCreate Address
/v1/addressesCreate an address. - GETRetrieve Address
/v1/addresses:addressIdRetrieve an address. - POSTUpdate Address
/v1/addresses:addressIdChange or modify an address. To clear a field, set it to an empty string. - DELETEDelete Address
/v1/addresses:addressIdRemove an address that is linked to a customer or is not linked to any object.
Customer Payment Method
- GETList Payment Methods of Customer
/v1/customers/:customerId/payment_methodsRetrieve payment methods for a customer - POSTAdd payment Method to Customer
/v1/customers/:customerId/payment_methodsAdd a payment method to a customer profile - GETRetrieve Payment Method
/v1/customers/:customerId/payment_methods/:pmtIdRetrieve a payment method for a specific customer - POSTUpdate Payment Method
/v1/customers/:customerId/payment_methods/:pmtIdChange or modify a payment method that was stored in a customer profile - DELETEDelete Payment Method
/v1/customers/:customerId/payment_methods/:pmtIdThis method triggers the Webhook - Payment Method Canceled webhook. This webhook contains more information than the response.
SKU
- GETRetrieve SKU
/v1/skus/:skuIdRetrieve the details of an SKU. - POSTUpdate SKU
/v1/skus/:skuIdChange or modify an SKU. - DELETEDelete SKU
/v1/skus/:skuIdDelete an SKU from the Rapyd platform. - GETList SKUs
/v1/skusRetrieve a list of all SKUs. - POSTCreate SKU
/v1/skusCreate an SKU and attach it to a product.
Order
- GETList Orders
/v1/ordersRetrieve a list of all orders. - POSTCreate Order
/v1/ordersCreate an order for goods. For services, see Create Subscription. - GETRetrieve Order
/v1/orders/:orderIdRetrieve the details of an order. - POSTUpdate Order
/v1/orders/:orderIdChange or modify an order. - POSTPay Order
/v1/orders/:orderId/payPay an order.
Order.Return
- POSTCreate a Return Against an Order
/v1/orders/:orderId/returnsMake a return against an order. The maximum amount of the return is the amount of the order - GETList Returns
/v1/order_returnsRetrieve a list of all order returns. - GETRetrieve a Return
/v1/order_returns/:orderReturnsIdRetrieve the details of a return.
Coupon
- GETList Coupons
/v1/couponsRetrieve a list of all coupons. - POSTCreate Coupon
/v1/couponscreate a coupon - GETRetrieve Coupon
/v1/coupons/:couponIdRetrieve a coupon - POSTUpdate Coupon
/v1/coupons/:couponIdModify the metadata of a coupon with a coupon ID in Path - DELETEDelete Coupon
/v1/coupons/:couponIdDelete a coupon from the Rapyd platform. Deleting a coupon removes it from all customers and subscriptions, but does not affect invoices and payment…
Disburse.Payout Method Type
- GETList Payout Method Types
/v1/payout_methodsRetrieve a list of payout method types that you can use when creating a payout. The response contains a list of objects. Each object includes a payout method… - GETGet Payout Required Fields
/v1/payout_methods/:pomt/required_fields?beneficiary_country=US&beneficiary_entity_type=company&payout_amount=0.0&payout_currency=USD&sender_country=US&sender_currency=USD&sender_entity_type=companyRetrieve the fields required to use a payout method type. The fields are returned as an array of objects. The name of each field appears in the name field of…
Disburse
- GETList Payouts
/v1/payoutsRetrieve a list of payouts that you created. - POSTCreate Payout
/v1/payoutsCreate a payout (disbursement).This method triggers the _Payout Created_ webhook. This webhook contains the same information as the response. If the action of… - POSTCreate Mass Payout
/v1/batch_process/files/mass_payout_pciCreate a batch of payouts (disbursements) from a file. To enable the use of this method, contact Rapyd support. A request input file must be added after the… - POSTComplete Payout
/v1/payouts/complete/:payoutToken/:amountUse this method in the sandbox to simulate the action of a third party that is required for completing the payout process.<BR> Relevant when the status of the… - POSTConfirm Payout
/v1/payouts/confirm/:payoutTokenConfirm the exchange rate of a payout that involves foreign exchange.<BR>Relevant when the payout was created with confirm_automatically set to false. - POSTSet Payout Response
/v1/payouts/responseAccept or decline a payout to a Rapyd Wallet.<BR>If the beneficiary accepts the payout, this method triggers the 'Payout Completed' webhook.<BR>If the… - GETRetrieve Sender
/v1/payouts/sender/:senderIdNote: The Retrieve Sender - individual response includes additional fields for the ca_general_bank payout method. The Retrieve Sender - company response… - GETRetrieve Payout
/v1/payouts/:payoutIdRetrieve the details of a payout. - POSTUpdate Payout
/v1/payouts/:payoutIdChange or modify a payout. This method triggers the Payout Updated webhook. This webhook contains the same information as the response. - DELETECancel Payout
/v1/payouts/:payoutIdThe payout can be canceled unless its status is confirmation or completed. This method triggers the Payout Canceled webhook. This webhook contains the same… - POSTSimulating a Payout Returned Status
/v1/payouts/return/:payoutUse this method in the sandbox to simulate the action of a third party that is required for returning the payout.<BR>Relevant when the status of the payout is…
Disburse.Payout Beneficiary
- POSTCreate Beneficiary
/v1/payouts/beneficiaryCreate a beneficiary for use in payouts.<BR>The response provides a unique beneficiary ID, which you can use in place of the Beneficiary object for _Create… - POSTCreate Extended Beneficiary
/v1/payouts/extended_beneficiaryCreate a beneficiary that includes all compliance related data for payouts. The response provides a unique beneficiary ID, which you can use in place of the… - POSTValidate Beneficiary
/v1/payouts/beneficiary/validateValidate the format of the details for a payout beneficiary. You can validate a beneficiary multiple times for different payout methods. You can enter a… - GETRetrieve Beneficiary
/v1/payouts/beneficiary/:beneficiaryIdRetrieve details of a payout beneficiary. Note: The 'Retrieve Beneficiary - individual' response includes additional fields for the 'ca_general_bank' payout… - POSTUpdate Beneficiary
/v1/payouts/beneficiary/:beneficiaryIdUpdate a beneficiary with additional fields. <BR>Note: You cannot update the values of the beneficiary fields which were defined when it was created. - DELETEDelete Beneficiary
/v1/payouts/beneficiary/:beneficiaryIdDelete a payout beneficiary from the Rapyd platform. - POSTCreate Beneficiary Tokenization Page
/v1/hosted/disburse/beneficiaryCreate a customer-facing page for creating a beneficiary token.<BR> This method creates a URL for a page where the customer enters details required for…
Disburse.Payout Sender
- POSTCreate Sender
/v1/payouts/senderCreate a sender for use in payouts. The response provides a unique sender ID, which you can use in place of the sender object for Create Payout. Note: In… - DELETEDelete Sender
/v1/payouts/sender/:senderIdDelete a payout sender from the Rapyd platform.
Disburse.Upload Documents
- POSTUpload Documents to Payout
/v1/files/documents/payout/:payoutUpload one supporting document file or multiple document files to a specific payout. These documents include ID scans, company registrations, and all other… - GETList Documents of Payout
/v1/payouts/:payout/documents/Retrieve details of all supporting document files that were previously uploaded to a specific payout. - DELETEDelete All Documents of Payout
/v1/payouts/:payout/documents/Delete all document files that were previously uploaded to a specific payout. - GETRetrieve Document of Payout
/v1/payouts/:payout/documents/:file_idRetrieve details of all supporting document files that were previously uploaded to a specific payout. - DELETEDelete Document of Payout
/v1/payouts/:payout/documents/:file_idDelete a document file that was previously uploaded to a specific payout.
Disburse.Card Eligibility
- POSTRetrieve Card Eligibility Details
/v1/cards/eligibilityRetrieve information about a beneficiary’s card to determine whether it is eligible for card payouts (Original Credit Transactions (OCT)), and card payments…
eWallet.Transaction
- POSTTransfer Funds Between Wallets
/v1/account/transferTransfer funds between Rapyd Wallets. - POSTSet Transfer Response
/v1/account/transfer/responseRespond to a funds transfer between wallets. The transferee uses this method to accept or decline the transfer. - POSTPut Funds on Hold
/v1/ewallets/accounts/balance/holdPut a hold on funds in the wallet. Sandbox only.<BR> This action transfers funds from the available balance to the on-hold balance. If the wallet does not… - POSTRelease Funds on Hold
/v1/ewallets/accounts/balance/releaseRelease a hold on funds in the wallet. Sandbox only.<BR>This action transfers funds from the on-hold balance to the available balance. If the wallet does not… - POSTSet Wallet Account Limit
/v1/ewallets/:walletId/account/limitsSet the maximum balance limit or the minimum balance threshold for an existing wallet account. - DELETEDelete Wallet Account Limit
/v1/ewallets/:walletId/account/limitsDelete a limit on a wallet account. - GETRetrieve Wallet Balances
/v1/ewallets/:walletId/accountsRetrieve details of the balances in a Rapyd Wallet. - GETList Wallet Transactions
/v1/ewallets/:walletId/transactions?balance=3422&page_size=20Retrieve a list of all transactions related to a wallet. - GETGet Details of Wallet Transaction
/v1/ewallets/:walletId/transactions/:transactionIdRetrieve the details of a wallet transaction.
eWallet.Contact
- GETList Contacts of Wallet
/v1/ewallets/:ewalletId/contactsRetrieve all contacts for a wallet. - POSTAdd Contact to Wallet
/v1/ewallets/:ewalletId/contactsAdd a personal contact to a company wallet or client wallet. - GETRetrieve Wallet Contact
/v1/ewallets/:ewalletId/contacts/:contactIdRetrieve a contact for an existing Rapyd Wallet. - POSTUpdate Wallet Contact
/v1/ewallets/:ewalletId/contacts/:contactIdUpdate a contact for a Rapyd Wallet. - DELETEDelete Wallet Contact
/v1/ewallets/:ewalletId/contacts/:contactIdDelete a personal contact from a company wallet or client wallet. - GETGet Compliance Status of Personal Contact
/v1/ewallets/:ewalletId/contacts/:contactId/compliance_levelsVerify the compliance status of a personal contact.
Issuing
- POSTDisplay Issued Card Details to Customer
/v1/hosted/issuing/card_details/:cardTokenGenerate a hosted page that displays details of a virtual issued card directly to the customer. The URL is available for 24 hours after the response is sent,… - GETList issuing Cards
/v1/issuing/cardsRetrieve a list of all issuing cards. - POSTIssue Card
/v1/issuing/cardsIssue a card to a wallet contact. - GETRetrieve Card Details
/v1/issuing/cards/:cardIdRetrieve the details of a card. - POSTActivate Issued Card Using API
/v1/issuing/cards/activateActivate a card that was issued via the Rapyd issuing platform. - POSTActivate Issued Card Using Hosted Page
/v1/hosted/issuing/activate_cardA contact can activate his or her physical issued card.<BR>Rapyd sends you webhooks for the following actions:<BR> * Personalize a card - See 'Bulk-Issued… - POSTCreate Hosted Page for PIN Management
/v1/hosted/issuing/pinCreate a hosted page for viewing and resetting a PIN.<BR>In the sandbox, you can set any number other than 1111.<BR>Rapyd sends you the 'Issued Card PIN Set'… - POSTPersonalize Bulk-Issued Card
/v1/issuing/cards/personalizeCreate a connection between an issued card and a wallet contact. Relevant to cards that are issued in bulk and not assigned to any specific person. This… - POSTUpdate Card Status
/v1/issuing/cards/statusBlock or unblock a card that was issued via the Rapyd issuing platform. - GETList Issued Card Transactions
/v1/issuing/cards/:cardId/transactions?page_size=20&page_number=stringUse the GET method to retrieve a list of transactions for a specific issued card. - GETRetrieve Issued Card Transaction Details
/v1/issuing/cards/:cardId/transactions/:transactionIdUse the GET method to retrieve details of a specific transaction from a specific issued card. - POSTSet PIN Code
/v1/issuing/cards/pinSet the PIN code for an issued card.<BR>This method triggers the 'Issued Card PIN Set' Webhook.<BR> Note:<BR>* In the sandbox, you can set any number other… - POSTAdd Card to Google Pay - Google Pay Push Provisioning
/v1/issuing/cards/:card_id/card_tokens/google_payAdd a card to a Google Pay wallet using Google Pay Push Provisioning.<BR>Note:<BR> * PCI certification is required for this method as it contains PCI… - POSTIssue Virtual Account Number
/v1/issuing/bankaccountsIssue a virtual account number to an existing wallet.
Issuing.Simulations
- POSTSimulate Blocking a Card
/v1/issuing/cards/simulate_blockSimulate a third-party stop notice for an issued card.<BR>Relevant to the sandbox.<BR>Rapyd sets the card status to BLO (blocked) and sends you the Card… - POSTSimulate a Card Transaction Authorization Request-EEA
/v1/issuing/cards/authorizationSimulate Rapyd’s request to your authorization server.<BR> If you have implemented Remote Authorization, Rapyd sends authorization requests to your remote… - POSTSimulate a Card Transaction Authorization Reversal-EEA
/v1/issuing/cards/reversalSimulate a retail location’s reversal of a card authorization.<BR>The retail location where a card was used for a purchase can send a reversal through the… - POSTSimulate Clearing a Card Transaction-EEA
/v1/issuing/cards/clearingSimulate clearing a debit transaction.<BR>This method triggers Webhook - Card Issuing Sale. When a fee is charged for an ATM transaction, this method also… - POSTSimulate a Card Refund-EEA
/v1/issuing/cards/refundSimulate a retail location making a refund to an issued card.<BR> This method triggers Card Issuing Refund Webhook. This method credits the available balance… - POSTSimulate a Card Transaction Adjustment - EEA
/v1/issuing/cards/adjustmentUse this method in the sandbox to simulate an adjustment to a card transaction. A retail location can adjust the amount of a transaction made by an issued…
Localization Methods
- GETGet FX Rate
/v1/fx_rates?action_type=string&buy_currency=string&sell_currency=stringRetrieve a daily rate for conversion of currencies in payments and payouts. Rapyd uses a snapshot of daily foreign exchange rates fetched at 9 PM UTC. The… - GETList Supported Languages
/v1/hosted/config/supported_languagesRetrieve a list of the languages supported for hosted pages.<BR> A hosted page can appear in many foreign languages. The language (or merchant_language) field… - GETList Countries
/v1/data/countriesRetrieve a list of all countries. - GETList Currencies
/v1/data/currenciesRetrieve a list of all currencies.
Webhook Methods
- GETRetrieve Webhook
/v1/webhooks/:webhookRetrieve a webhook. Use 'List Webhooks' to find the IDs of webhooks. - POSTResend Webhook
/v1/webhooks/:webhookResend a webhook that was not sent successfully. Use 'List Webhooks' to find the IDs of webhooks. You can resend a webhook that is in status ERR. - GETList Webhooks
/v1/webhooksRetrieve a list of all webhooks that were sent. You can filter the list with query parameters.
Verify
- POSTVerify Identity
/v1/identitiesVerification of the identity of a personal contact associated with a wallet. - GETList ID Documents
/v1/identities/types?country=USUse this method to determine the types of documents to use for identification purposes, and also whether you need the reverse side of the document. You can… - GETList Verify Application Types
/v1/verify/applications/types/country/:countryRetrieve a List types of identity verification applications by country. You can filter the list with query parameters. - GETRetrieve verify Application Status
/v1/verify/applications/status/:applicationRetrieve the status of an application for verification of identity. You can filter the list with query parameters. - POSTCreate Hosted Verify Application
/v1/verify/applications/hostedCreate an application for Rapyd Verify where the client (applicant) provides information directly to Rapyd. After the applicant submits the application on the… - GETGet Verify Hosted Application
/v1/verify/applications/hosted/:verifyAppIdRetrieve Rapyd Verify Application - POSTCreate Identity Verification Page
/v1/hosted/idvCreate a hosted page for verifying the identity of a personal contact for a Rapyd Wallet.<BR>The customer completes the process by accessing the URL returned…
Card Network Lookup Service
- POSTInitiate Merchant Query
/v1/cnl/termination_querySubmit information about a merchant to begin the process of querying the merchant history in the databases of the card networks.<BR>This method validates the… - GETRetrieve Query Results
/v1/cnl/termination_query/:partner_query_referenceSubmit information about a merchant to begin the process of querying the merchant history in the databases of the card networks.<BR>This method validates the…
eWallet
- POSTAdd Funds to Wallet Account
/v1/account/depositTransfer virtual currency to a Rapyd Wallet account.<BR>If the account does not already exist for the indicated currency, it is created.<BR>Use this method in… - GETGet Details of Add Funds Request
/v1/account/deposit/:idRetrieve details of a specific 'Add Funds to Wallet Account' request.<BR> Use this method in the sandbox for testing purposes. - POSTRemove Funds From Wallet Account
/v1/account/withdrawRemove virtual currency from a Rapyd Wallet account.<BR>If the account does not have sufficient funds in the indicated currency, the funds transfer… - GETGet Details of Remove Funds Request
/v1/account/withdraw:idRetrieve details of a specific 'Remove Funds From Wallet Account' request.<BR>Use this method in the sandbox for testing purposes. - GETList eWallets
/v1/ewalletsRetrieve a list of Rapyd Wallets. You can filter the list with query parameters. - POSTCreate Wallet
/v1/ewalletsCreate a Rapyd Wallet. - GETRetrieve Wallet
/v1/ewallets/:ewalletTokenRetrieve the details of a Rapyd Wallet. - POSTUpdate Wallet
/v1/ewallets/:ewalletTokenChange or modify a Rapyd Wallet. - DELETEDelete Wallet
/v1/ewallets/:ewalletTokenDelete a Rapyd Wallet. Use this method when the wallet has never been used. This method triggers the Wallet Deleted webhook. This webhook contains the same… - POSTChange Wallet Status
/v1/ewallets/:ewalletToken/statuses/:statusChange Wallet Status
eWallet.Virtual Account
- POSTIssue Virtual Account Number to Wallet
/v1/virtual_accountsIssue a virtual account number to an existing wallet. - POSTSimulate a Bank Transfer to a Wallet
/v1/virtual_accounts/transactionsSimulate a deposit to a virtual account number that was issued to a wallet. This method is relevant only for testing in the sandbox. The currency of the… - GETRetrieve Virtual Account History
/v1/virtual_accounts/:virtualAccountIdRetrieve a Virtual Account Number object for a wallet. - POSTUpdate Requested Currency
/v1/virtual_accounts/:virtualAccountIdDefine, change, or cancel the currency to which funds received by a virtual account are converted.<BR>The status of the virtual account must be ACT (active)… - DELETEClose VA
/v1/virtual_accounts/:virtualAccountIdDelete a virtual account number of an existing wallet. In order to close a virtual account its status must be ACT. - GETIssue Virtual Account Number
/v1/virtual_accounts/capabilities/:countryRetrieve a list of the capabilities of virtual accounts you can issue to a Rapyd Wallet.<BR> The list is filtered by country. - GETList Virtual Accounts by Rapyd Wallet
/v1/ewallets/:ewallet/virtual_accountsList the virtual accounts that are attached to a Rapyd Wallet. - GETRetrieve Remitter Details
/v1/issuing/bankaccounts/remitters/:virtualAccountId/transactions/:transaction_idRetrieve the details of the remitter of a transfer to a virtual bank account. - GETRetrieve Virtual Account Transaction
/v1/issuing/bankaccounts/:virtualAccountId/transactions/:transactionIdRetrieve a virtual account transaction.
API details
- Base URL
https://sandboxapi.rapyd.nethttps://api.rapyd.net- Authentication
- None declared in the description
- Operations
- 203 operations on 143 pathsPOST 97GET 82DELETE 24
- Main resources
- Issuing 14Subscription.Invoice 12Disburse 11eWallet 10eWallet.Transaction 9eWallet.Virtual Account 9Subscription 8Customer 7Disburse.Payout Beneficiary 7Payment 7
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
1.0.23 - Links
- OpenAPI document
- Listed from
- Rapyd's published OpenAPI description (Rapyd-Samples/RapydOpenAPI) (MIT)
How to test the Rapyd API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Rapyd API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “List Payment Methods by Country” (GET /v1/payment_methods/countries/:countryId), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Rapyd API?
This is a release of the OpenAPI specification for Rapyd's API methods. It is recommended to initially run the methods in the sandbox environment. For the… It is listed under Payments and has 203 endpoints.
Who publishes the Rapyd API?
It is listed from Rapyd's public API description (an OpenAPI document), not published by Rapyd on Swastik Codes. Anyone who controls rapyd.net can claim the profile by adding a DNS TXT record.
What is the base URL of the Rapyd API?
Its description lists 2 base URLs: https://sandboxapi.rapyd.net, https://api.rapyd.net. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Rapyd API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Rapyd API have?
203 operations on 143 paths (97 POST, 82 GET, 24 DELETE). The largest groups are Issuing, Subscription.Invoice, Disburse, eWallet.
Is forking the Rapyd API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.