Get payment link

GET

/PaymentLink/load/:paylinkId

GET

/api/PaymentLink/load/:paylinkId

$ curl https://api-sandbox.payabli.com/api/PaymentLink/load/paylinkId \
>      -H "requestToken: <apiKey>"

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

Retrieves a payment link by ID.

Authentication

requestTokenstring

API Key authentication via header

Path parameters

paylinkIdstringRequired

ID for payment link

Response

Success

isSuccessboolean

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

responseDataobject

responseTextstring

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

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error