Get payment link

GET

/PaymentLink/load/:paylinkId

GET

/api/PaymentLink/load/:paylinkId

$ curl https://api-sandbox.payabli.com/api/PaymentLink/load/2325-XXXXXXX-90b1-4598-b6c7-44cdcbf495d7-1234 \
>      -H "Authorization: Bearer <token>"

1 {
2   "responseText": "Success",
3   "isSuccess": true,
4   "responseData": {
5     "AdditionalData": {
6       "key1": {
7         "key": "value"
8       },
9       "key2": {
10         "key": "value"
11       },
12       "key3": {
13         "key": "value"
14       }
15     },
16     "Credentials": [
17       {}
18     ],
19     "LastAccess": "2022-06-30T15:01:00Z",
20     "PageContent": {
21       "amount": {
22         "enabled": true
23       },
24       "autopay": {
25         "enabled": true
26       },
27       "contactUs": {
28         "enabled": true
29       },
30       "entry": "8cfec329267",
31       "invoices": {
32         "enabled": true
33       },
34       "logo": {
35         "enabled": true
36       },
37       "messageBeforePaying": {
38         "enabled": true
39       },
40       "name": "name",
41       "notes": {
42         "enabled": true
43       },
44       "page": {
45         "enabled": true
46       },
47       "paymentButton": {
48         "enabled": true
49       },
50       "paymentMethods": {
51         "enabled": true
52       },
53       "payor": {
54         "enabled": true
55       },
56       "review": {
57         "enabled": true
58       },
59       "subdomain": "mypage-1"
60     },
61     "pageIdentifier": "null",
62     "PageSettings": {
63       "color": "color",
64       "customCssUrl": "customCssUrl",
65       "language": "language",
66       "redirectAfterApprove": true,
67       "redirectAfterApproveUrl": "redirectAfterApproveUrl"
68     },
69     "published": 1,
70     "ReceiptContent": {
71       "amount": {
72         "enabled": true
73       },
74       "contactUs": {
75         "enabled": true
76       },
77       "details": {
78         "enabled": true
79       },
80       "logo": {
81         "enabled": true
82       },
83       "messageBeforeButton": {
84         "enabled": true
85       },
86       "page": {
87         "enabled": true
88       },
89       "paymentButton": {
90         "enabled": true
91       },
92       "paymentInformation": {
93         "enabled": true
94       },
95       "settings": {
96         "enabled": true
97       }
98     },
99     "Subdomain": "mypage-1",
100     "totalAmount": 1.1,
101     "validationCode": "validationCode"
102   }
103 }

Retrieves a payment link by ID.

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 payment link

Response

Success

responseTextstring

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

isSuccessboolean

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

responseDataobject

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error