v1

latestOpenAPI 3.0.02026-07-263118119.8 KB
Create & Manage Transactions

paymentLink

Send a payment link via SMS to the specified phone number for the given merchant.

<details> <summary><strong>Error Glossary</strong> (click to expand)</summary>
CodeHTTP StatusMessage
AP009401Unauthorized
AP101401No authenticated user
AP204200Location does not belong to merchant
AP207200No merchant found
AP208200Failed to fetch location for uuid
AP209200Location uuid does not match merchant
AP700400Missing or invalid required parameter
</details>
post/v2/paymentLink

Headers

Content-Typestring required
Acceptstring
authorizationstring required

A merchant scoped token.

Request body

merchantIdstring required

The unique identifier for the merchant.

phonestring required

The user's phone number to send the payment link to.

Response

Success - Payment Link Sent

messagestring