GuidesAPI Reference
API Reference

/v2/hosted/link

post
https://example.com/v2/hosted/link

Initiate a hosted payment flow process outside of a conventional e-commerce checkout experience.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required
Defaults to NONE

Specifies how the borrower is notified to complete the payment flow. When set to NONE, no notification is sent and the payment URL is returned in the response.

Allowed:
string
enum
Defaults to AUTHORIZED

When the borrower completes the payment flow successfully, this is the status that will be automatically applied to the order.

Allowed:
merchant
object
required

Merchant specific values related to the order.

metadata
object

A key/value blob for additional order information.

sales_representative
object

Identifying information about the sales rep initiating the order.

customer_information
object
required

Customer contact information

billing_address
object

The billing address for this order

shipping_address
object

The shipping address for this order

number
required

The total amount for this order in USD.

charges
object

Optional charge breakdown metadata for this order.

items
array of objects

Array of items associated with this order.

items
Responses

Updated about 1 month ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago