Settle

post

https://api.frisbii.com/v1/invoice/{id}/settle

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Settle pending, dunning or failed invoice using a customer payment method or subscription payment method for a subscription invoice. For a customer invoice an optional due date and time can be supplied delaying the settle until this date and time.

Returns an Invoice object. The invoice state depends on the origin of the invoice. A one-time customer invoice will be either settled or failed while a subscription invoice will keep its state if the settle fails.

Errors

The operation can generate the following errors beside the generic HTTP error codes described here.

Error code	HTTP code	Description
`31`	`404`	Invoice not found
`80`	`400`	Invoice cannot be settled because it has processing transactions
`76`	`400`	Payment method not provided
`40`	`404`	Payment method not found
`147`	`400`	Stored payment method is in failed state and it is not allowed to retry because of scheme or payment provider rules

Path Params

string

required

Invoice id or handle

Body Params

Optional settle to perform after creation using a different payment method. If the settle fails the status will be failed if instant or pending if not instant. The due date will be ignored for subscription invoice create.

due

string

Optional due date and time on the form yyyy-MM-dd, yyyyMMdd, yyyy-MM-ddTHH:mm and yyyy-MM-ddTHH:mm:ss from which the invoice should be tried settled. Only allowed for one-time customer invoices.

payment_method

string

Payment method id to use to settle invoice. Must be a payment method supporting instant settle, e.g. credit card. A special value auto can be used to indicate that the newest active customer payment method should be used. Is required for one-time invoices if the amount on the invoice is more than zero.

Responses

Errors

200Successful operation

400Invalid request, see error codes at https://api.frisbii.com/v1/error_codes

401None or invalid credentials provided in access to secured resource

403Not authorized to perform resource operation

404Resource or referenced resource not found, see error codes at https://api.frisbii.com/v1/error_codes

429Request limiting exceeded, request rate or concurrent requests, see error code 122 and 123

500Internal service error, error is reported automatically to Frisbii