API Reference

Pay invoice

post
https://api.synaptopay-sandbox.com/v1/accounts//invoices/:pay

Required capability: billing

Path Params
string
required
string
required
Body Params
string
required

Name of the payment method to pay the invoice with.

Example: "accounts/acct_RwDJsJd8z0exhtfX2570Q/payment-methods/pm_qkwjndkqwjndkq".

boolean

Optional. Set when the customer is not present, for example a scheduled charge. Requires a
payment method saved for future use; the IP address captured when it was saved is used where
the card processor requires one. Defaults to false: the customer is present.

string

Optional. Public IP address of the customer present at payment, for example "203.0.113.42". The only
source of the customer's IP on this API: X-Forwarded-For is not used. Required when saving a card and by
some card processors. Not allowed when off_session is true.

Response

Updated 7 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago

Did this page help you?