API Reference

Create Order

post
https://gateway.paybyrd.com/api/v2/orders

This endpoint allows you to create a new order. Orders are used within Paybyrd's hosted form integration or PayByLink feature.

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

Total amount for this transaction in ISO format, with the following pattern "2500" (to express 25.00)

string
required

Valid ISO-4217 alpha code e.g EUR

string
required

Merchant reference for this order

shopper
object
ShoppingCart
array
ShoppingCart
orderOptions
object

Defines settings for this order

paymentOptions
object

Defines settings for payment.

metadata
object

Metadata allows you to pass any data to Paybyrd which will be returned in the order query and also sent in the status changed notifications.

Response

Updated 3 months ago

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

Updated 3 months ago