For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
LoginSandbox
Platform GuidesAPI DocsSDKMCP ServerChangelog
Platform GuidesAPI DocsSDKMCP ServerChangelog
  • Solvimon API
    • Base URL
    • Authentication
    • HTTP status codes
    • Resources
    • Standardisation
  • Configuration API
  • Identity API
  • Transaction API
      • GETGet a list of payments
      • POSTCreate a payment
      • GETGet a payment by ID
      • POSTRefund a payment
      • POSTAuthorize a payment
      • POSTVerify payment details
      • GETGet Payment Requests
      • GETGet a Payment Request by ID
  • Event API
LoginSandbox
Transaction APIPayments

Get Payment Requests

GET
/v:version/payment-requests
GET
/v:version/payment-requests
$curl https://api.solvimon.com/v1/payment-requests \
>     -H "X-API-KEY: <apiKey>"
1{
2  "data": [
3    {
4      "object_type": "string",
5      "id": "string",
6      "payment_schedule_id": "string",
7      "customer_id": "string",
8      "customer": {
9        "object_type": "string",
10        "id": "string",
11        "created_at": "string",
12        "parent_customer_id": "string",
13        "parent_customer_ids": [
14          "string"
15        ],
16        "reference": "string",
17        "status": "DRAFT",
18        "timezone": "string",
19        "type": "ORGANIZATION",
20        "email": "string",
21        "notification_preferences": [
22          {
23            "type": "INVOICE",
24            "channels": [
25              {
26                "type": "EMAIL",
27                "enabled": true
28              }
29            ]
30          }
31        ],
32        "locale": "string",
33        "individual": {
34          "name": {
35            "first_name": "string",
36            "last_name": "string",
37            "infix": "string"
38          },
39          "residential_address": {
40            "line1": "string",
41            "line2": "string",
42            "city": "string",
43            "postal_code": "string",
44            "state": "string",
45            "country": "AD"
46          }
47        },
48        "organization": {
49          "legal_name": "string",
50          "tax_id": "string",
51          "tax_ids": [
52            {
53              "id": "string",
54              "type": "GENERIC_TAX_ID",
55              "display_name": "string",
56              "tax_id_validation_result": {
57                "id": "string",
58                "validation_date": "string",
59                "source": "string",
60                "valid": "VALID",
61                "message": "string"
62              }
63            }
64          ],
65          "registration_number": "string",
66          "tax_exempt": true,
67          "tax_exempt_note": "string",
68          "registered_address": {
69            "line1": "string",
70            "line2": "string",
71            "city": "string",
72            "postal_code": "string",
73            "state": "string",
74            "country": "AD"
75          },
76          "tax_registrations": [
77            {
78              "id": "string",
79              "description": "string",
80              "tax_id": "string",
81              "tax_ids": [
82                {
83                  "id": "string",
84                  "type": "GENERIC_TAX_ID",
85                  "display_name": "string",
86                  "tax_id_validation_result": {
87                    "id": "string",
88                    "validation_date": "string",
89                    "source": "string",
90                    "valid": "VALID",
91                    "message": "string"
92                  }
93                }
94              ],
95              "registration_number": "string",
96              "registered_address": {
97                "line1": "string",
98                "line2": "string",
99                "city": "string",
100                "postal_code": "string",
101                "state": "string",
102                "country": "AD"
103              }
104            }
105          ]
106        },
107        "custom_fields": [
108          {
109            "id": "string",
110            "reference": "string",
111            "value": "string",
112            "values": [
113              "string"
114            ],
115            "integration_details": {
116              "id": "string",
117              "reference": "string",
118              "payment_gateway_variant": "ADYEN",
119              "adyen": {
120                "recurring_detail_reference": "string"
121              },
122              "stripe": {
123                "payment_method_id": "string"
124              }
125            }
126          }
127        ],
128        "processing_only": true,
129        "pricing_plan_subscription_selector": {
130          "data": [
131            {
132              "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
133              "value": "string"
134            }
135          ],
136          "rules": [
137            {
138              "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
139              "type": "EQUALS"
140            }
141          ],
142          "filters": [
143            {
144              "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
145              "type": "EQUALS",
146              "value": "string"
147            }
148          ],
149          "fallback": "LATEST"
150        },
151        "linked_integrations": [
152          {
153            "id": "string",
154            "link_details": [
155              {
156                "url": "string",
157                "custom_field_name": "string"
158              }
159            ]
160          }
161        ],
162        "roles": [
163          "DEFAULT"
164        ],
165        "seller_details": {
166          "default_billing_entity_id": "string"
167        }
168      },
169      "status": "SCHEDULED",
170      "created_at": "string",
171      "execute_at": "string",
172      "index": 1,
173      "amount": {
174        "quantity": "string",
175        "currency": "AED"
176      }
177    }
178  ],
179  "page": 1,
180  "limit": 1,
181  "links": {
182    "first": "string",
183    "previous": "string",
184    "current": "string",
185    "next": "string"
186  },
187  "total_number_of_pages": 1
188}

Requires the PAYMENT_REQUEST.VIEW permission.

Was this page helpful?
Previous

Get a Payment Request by ID

Next
Built with

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1
version

Headers

x-platform-idstringOptional
Platform ID.

Query parameters

customer_idstringOptional
Filter based of customer ID
payment_schedule_idstringOptional
Filter based of payment schedule ID
statuses[]list of stringsOptional

Filter payment requests based on status(es)

expand[]list of stringsOptional
The id fields of the resources that are going to be expanded.
limitintegerOptional
The amount of records shown in the list
pageintegerOptional
The page which is going to be shown
order_bystringOptional
The parameter by which the response is ordered.
order_directionstringOptional
The order direction by which the response is ordered.

Response

OK
datalist of objects
pageinteger or null
limitinteger or null
linksobject
total_number_of_pagesinteger or nullDeprecated

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error