Credit from payment method

Charge a customer's payment method and credit the amount to their balance.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Charges a customer's payment method and credits the resulting amount to their account balance.

How it works

  1. The payment method is charged for the specified amount
  2. A charge record is created
  3. A balance transaction is created crediting the customer
  4. The customer's balance is updated

Constraints

  • The payment method must belong to the specified customer
  • Amount is in cents (e.g. 1000 = $10.00)
  • Minimum amount is 1 cent
Query Params
integer
required

The site ID to scope this request to.

Body Params
integer
required

The customer to credit.

integer
required

The payment method to charge. Must belong to the customer.

integer
required
≥ 1

Amount to credit in cents (e.g. 1000 = $10.00).

string
required
length between 3 and 3

Three-letter ISO currency code (e.g. usd, cad).

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json