Skip to main content

Documentation

Payment

Collects money from a payment method and deposits it into one or more Rapyd Wallets.

A payment comes into existence upon one of the following events:

  • On demand - For one of the following types of transactions:

    • Individual order - The client processes an order and initiates the process for collecting money from the customer.

    • Wallet funding - The client or customer transfers money to a Rapyd Wallet. This can be done to fund the wallet, pay wages, pay for goods sold, or pay service fees.

    • Order - The client pays an order with a selected payment method.

    • Invoice - The client pays an invoice with a selected payment method.

    • Checkout - The customer is interacting with a hosted page and initiates a payment transaction.

  • Automatically - A subscription is set up to make payments on a regular schedule.

The payment is completed upon one of the following events:

  • The automatic collection is successful, such as when a card payment is captured.

  • capture is set to false and the client uses the Capture Payment method. For example, a car rental company puts a hold on the customer's card when the car is taken out, and captures the payment when the car is returned.

  • The customer completes the steps required in the instructions field, for example, depositing money into an ATM or completing a bank transfer on a website.

Rapyd supports numerous payment methods in the following categories:

  • card - A credit card or debit card drawn on a bank.

  • cash - Funds deposited at a point-of-sale location.

  • bank transfer - Transfer of funds from a specified bank account.

  • bank redirect - Online payment where the customer is redirected to a third-party banking website to complete the transfer.

  • ewallet - A local ewallet.

Methods - Payment

Payment Webhooks

Synchronous Webhooks

Synchronous webhooks contain exactly the same information as the data section of the response and may not be reproduced in the API Reference.

Asynchronous Webhooks

Error Messages