Create offline charge

Create an offline charge (payment record) for a customer.

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

The unique identifier of the site associated with your account.

Body Params
int32

The customer ID to charge. Required if customer_old_provider_id is not provided.

string

Alternative to customer_id. The old provider ID of the customer to charge.

int32
required
1 to 2147483647

The amount in cents to charge. Minimum 1, maximum 2147483647. If an invoice_id is provided and the invoice is paid, must match the invoice total.

string
required
length between 1 and 255

Reference number for this charge (e.g. check number, wire reference, lockbox ID).

string
required
length between 3 and 3

Three-letter ISO currency code (e.g. usd, cad). Must be valid for the account and customer.

string
enum

Payment method category: 2 for check, 3 for wire, 4 for transfer, 5 for external, 6 for cash.

Allowed:
int32

The invoice ID to associate this charge with. Must exist on the account.

string

Alternative to invoice_id. The old provider ID of the invoice to associate this charge with.

Headers
string
required
Defaults to Bearer eyJ***
Responses

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