HomeProduct DocsAPI ReferenceChangelog
RecurlyAPI GuidesRecurly.jsWebhooksAPI ReferenceSupportBook demo
API Reference

Record an external payment for a manual invoices.

This endpoint allows you to record an offline payment that was not captured through your gateway. It will throw an error for an auto-collecting invoice.

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

Invoice ID or number. For ID no prefix is used e.g. e28zov4fw0v2. For number use prefix number-, e.g. number-1000. For number with prefix or country code, use number- and prefix, e.g. number-TEST-FR1001

Body Params
string
enum

Payment method used for external transaction.

string
length ≤ 50

Used as the transaction's description.

float

The total amount of the transcaction. Cannot excceed the invoice total.

date-time

Datetime that the external payment was collected. Defaults to current datetime.

Responses

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