Create & Manage Transactions

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

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

Request

Headers

Content-Typestring required
Acceptstring
authorizationstring required

A merchant scoped token.

Request body

merchantIdstring required

The unique identifier for the merchant.

phonestring

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.

emailstring

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.

referenceIdstring

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

userIdstring

The unique identifier for the user the link is for.

paymentTypestring

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

Response

Success - Payment Link Sent

messagestring
referenceIdstring

Changes

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status