paymentLink

post

https://api.sandbox-pay.aero.inc/v2/paymentLink

Send a payment link via SMS or email for the given merchant.

Error Glossary (click to expand)

Code	HTTP Status	Message
`AP009`	401	Unauthorized
`AP101`	401	No authenticated user
`AP201`	200	No merchant found for merchant id
`AP203`	200	Unable to get location for merchant
`AP204`	200	Location does not belong to merchant
`AP208`	200	Failed to fetch location for uuid
`AP700`	400	Missing or invalid required parameter
`AP701`	400	Improperly formatted parameter

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

merchantId

string

required

The unique identifier for the merchant.

phone

string

The user's phone number to send the payment link to. One of phone or email is required; if both are supplied, phone delivery is used.

string

The user's email address to send the payment link to. One of phone or email is required; if both are supplied, phone delivery is used.

merchantLocationId

The merchant location id or uuid to associate with the payment link. Must belong to the merchant in merchantId. Defaults to the merchant's default location if omitted.

referenceId

string

Merchant reference id of the payment link. Max length 64.

amount

object

Dictionary with currency and amount in pennies. Only USD supported at this time

userId

string

The unique identifier for the user the link is for.

paymentType

string

Type of payment link to generate, e.g. preauth/preauthorized. subscription is not supported.

Headers

authorization

string

required

A merchant scoped token.

Responses

200Success - Payment Link Sent

400Bad Request

401Unauthorized