Payment Links

Payment links via API

Aeropay offers a paymentLink API which generates and sends an Aeropay payment link for your merchant location to a customer's email or phone number.

Request parameters

ParameterRequired?TypeDescription
phonephone or email is requiredStringThe phone number to send the payment link to
emailphone or email is requiredStringThe email address to send the payment link to
uuidYesStringThe merchant location uuid
amountNoStringAmount value in USD
paymentTypeNoStringThe paymentType: standard, preauth, or subscription. Defaults to standard.
subscriptionIdNoStringSubscription offer id if paymentType is 'subscription'
transaction_uuidNoStringUnique uuid (ISO/IEC 9834-8) to identify the transaction. This value can be used to associate Aeropay transactions with your own system.

Code Example - Request

curl --request POST \
     --url https://staging-api.aeropay.com/paymentLink \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "phone": "7865641122",
  "amount": "10.00",
  "uuid": "4557b52c-e55f-44e0-a45a-7bfd032cdae9",
  "paymentType": "standard"
}
'

Build-Your-Own Payment Links

Alternatively, you can build payment links by adding parameters to the base URL, pay.aero.inc. Parameters include your merchant location uuid, transaction amount, and transaction id. Please note, you must generate the UUID according to the standard methods (ISO/IEC 9834-8).

In the sandbox environment, the base URL will be staging-pay.aero.inc

PAYMENT URL: baseurl + ?m= + Merchant location UUID + &t= + transaction Total Amount + &u= + transaction UUID

example:
https://pay.aero.inc/?m=3294913115&t=30.24&u=123e4567-e89b-12d3-a456-426614174000