Create offline charge

post

https://www.pelcro.com/api/v1/core/charges

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

Query Params

site_id

int32

required

The unique identifier of the site associated with your account.

Body Params

customer_id

int32

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

customer_old_provider_id

string

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

amount

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.

reference

string

required

length between 1 and 255

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

currency

string

required

length between 3 and 3

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

payment_category

string

enum

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

Allowed:

invoice_id

int32

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

invoice_old_provider_id

string

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

Headers

Authorization

string

required

Defaults to Bearer eyJ***

Responses

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success.

400Invalid request.

401Unauthenticated.