API Reference

Execute a payment attempt for a specific account with arbitrary payment method

post
https://Contact sales to enable your sandbox/accounts//line_items/payments/guest_payment

Canopy will first try to execute a payment via the supplied payment method, and then store the corresponding record in Canopy's system.

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

ID of the Account

Body Params

Body of request to create guest payment.

string
^(?!can_).*$

The ID to be associated with the line item for future requests.

date-time

The Date-Time that the payment is applicable to the account. This field should only be used to back-date payment transactions for the purpose of testing or if a data migration is being performed with migration_mode enabled.

integer
required
Defaults to 0

The payment amount in cents.

payment_details
object
required
external_fields
object | null

External fields can be used to relate payments created in Canopy to entities in your or any external system.

Responses

422

Invalid input.

429

Too many requests.

default

Unexpected Error.

Updated about 1 year ago

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

Updated about 1 year ago

Did this page help you?