Update Pay Out payment link content

PATCH

/PaymentLink/updateOut/:paylinkId

PATCH

/api/PaymentLink/updateOut/:paylinkId

$ curl -X PATCH https://api-sandbox.payabli.com/api/PaymentLink/updateOut/2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234 \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "contactUs": {
>     "emailLabel": "Email",
>     "enabled": true,
>     "header": "Contact Us",
>     "order": 0,
>     "paymentIcons": true,
>     "phoneLabel": "Phone"
>   },
>   "logo": {
>     "enabled": true,
>     "order": 0
>   },
>   "messageBeforePaying": {
>     "enabled": true,
>     "label": "Please review your payment details",
>     "order": 0
>   },
>   "notes": {
>     "enabled": true,
>     "header": "Additional Notes",
>     "order": 0,
>     "placeholder": "Enter any additional notes here",
>     "value": ""
>   },
>   "page": {
>     "description": "Get paid securely",
>     "enabled": true,
>     "header": "Payment Page",
>     "order": 0
>   },
>   "paymentButton": {
>     "enabled": true,
>     "label": "Pay Now",
>     "order": 0
>   },
>   "paymentMethods": {
>     "allMethodsChecked": true,
>     "allowMultipleMethods": true,
>     "defaultMethod": "vcard",
>     "enabled": true,
>     "header": "Payment Methods",
>     "methods": {
>       "ach": true,
>       "check": true,
>       "vcard": true
>     },
>     "order": 0,
>     "showPreviewVirtualCard": true
>   },
>   "review": {
>     "enabled": true,
>     "header": "Review Payment",
>     "order": 0
>   },
>   "settings": {
>     "color": "#000000",
>     "language": "en"
>   }
> }'

1 {
2   "isSuccess": true,
3   "responseText": "Success",
4   "responseData": "2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234"
5 }

Updates the payment page content for a Pay Out payment link. Use this to change the branding, messaging, payment methods offered, or other page configuration.

Authentication

AuthorizationBearer

OAuth2 Bearer access token from the client-credentials flow. See OAuth authentication.

requestTokenstring

Long-lived API token sent in the requestToken header. See API token authentication.

Path parameters

paylinkIdstringRequired

ID for the payment link.

Request

This endpoint expects an object.

contactUsobjectOptional

ContactUs section of payment link page.

logoobjectOptional

Logo section of payment link page.

messageBeforePayingobjectOptional

Message section of payment link page.

notesobjectOptional

Notes section of payment link page.

pageobjectOptional

Page header section of payment link page.

paymentButtonobjectOptional

Payment button section of payment link page.

paymentMethodsobjectOptional

Payment methods section of payment link page. Use this to configure which payout methods (ACH, vCard, check) are offered to the vendor.

reviewobjectOptional

Review section of payment link page.

billsobjectOptional

Bills section of payment link page.

settingsobjectOptional

Settings section of payment link page.

Response

Success

isSuccessboolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

responseDatastring

If isSuccess = true, this contains the payment link identifier. If isSuccess = false, this contains the reason of the error.

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error