Pay invoice

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

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

Description

Use this protected endpoint to allow an authenticated customer to pay an outstanding invoice using an existing or new payment method. This will automatically charge the customer for the full amount remaining to be paid on the invoice.

Related webhook events

Related features

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

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

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


xxxxxxxxxx
1
curl --request POST \
2
     --url https://www.pelcro.com/api/v1/sdk/invoices/invoice_id/pay \
3
     --header 'Accept: application/json' \
4
     --header 'Authorization: Bearer eyJ***' \
5
     --header 'content-type: application/json'

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

Description

Related webhook events

Related features

200200