Create Payment (Online)

post

https://api.au.app.waavetest.com/merchant/v1/payments

Create a payment for e-commerce.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

customerReference

string

The business's own reference for this payment (auto-generated by Waave if not present).

totalAmount

int64

required

≥ 1

The total amount to be charged (in cents).

currency

string

enum

The ISO 4217 alpha-3 currency code. If not present, default currency of the business account is used.

Allowed:

businessCode

string

required

The business's unique code (assigned by Waave).

billingAddress

object

The billing address.

shippingAddress

object

The shipping address.

effectiveFromAt

date-time

The ISO 8601 formatted time that the payment session is effective from.

effectiveToAt

date-time

The ISO 8601 formatted time that the payment session is effective to.

notificationUrl

string

length between 0 and 4095

The URL to receive webhook notifications about payment session status changes.

returnUrl

string

length between 0 and 4095

The URL to redirect back to once the payment session is complete.

orderItems

array of objects

required

orderItems*

string

The shopper's email address.

phoneNumber

string

The shopper's phone number.

additionalData

object

The additional data.

dataHolderBrandId

string

The brand identifier of the data holder.

recurringAgreement

object

The recurring agreement request.

recurringCharge

object

The recurring charge request.

Headers

Idempotency-Key

string

If specified, guarantees that only one resource will be created per idempotency key per business (merchant).

Responses

400

Request message is invalid or not well-formed

401

Full authentication is required to access this resource

422

Request could not be processed

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Payment Created