Pay invoice

post

https://www.pelcro.com/api/v1/sdk/invoices/{invoice_id}/pay

Allow your customer to pay for outstanding invoices on-session.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

invoice_id

int32

required

The unique identifier of the open invoice.

Query Params

site_id

int32

required

The unique identifier of the site associated with your account.

Body Params

source_id

int32

The unique identifier of an existing chargeable payment method already attached to the customer, which will be used to attempt payment for this invoice. Required when payment_gateway and gateway_token are not provided.

payment_gateway

string

enum

The optional payment gateway, one of stripe, braintree, vantiv, tap or cybersource. Required with gateway_token if source_id is not set.

Allowed:

gateway_token

string

The single-use token that represents the payment method details. Typically generated using the payment gateway's tools and libraries. This payment method will be used to attempt paying for this invoice. Required with payment_gateway if source_id is not set.

Headers

Authorization

string

required

Defaults to Bearer eyJ***

string

Defaults to application/json

Response

Language

Credentials

Query

Loading…

Response

Click Try It! to start a request and see the response here!

200200