Get Payment Requests | Solvimon

curl https://api.solvimon.com/v1/payment-requests \
     -H "X-API-KEY: <apiKey>"

{
  "data": [
    {
      "object_type": "string",
      "id": "string",
      "payment_schedule_id": "string",
      "customer_id": "string",
      "customer": {
        "reference": "string",
        "type": "ORGANIZATION",
        "email": "string",
        "roles": [
          "DEFAULT"
        ],
        "object_type": "string",
        "id": "string",
        "created_at": "string",
        "parent_customer_id": "string",
        "parent_customer_ids": [
          "string"
        ],
        "status": "DRAFT",
        "timezone": "string",
        "notification_preferences": [
          {
            "type": "INVOICE",
            "channels": [
              {
                "type": "EMAIL",
                "enabled": true
              }
            ]
          }
        ],
        "locale": "string",
        "individual": {
          "name": {
            "first_name": "string",
            "last_name": "string",
            "infix": "string"
          },
          "residential_address": {
            "line1": "string",
            "line2": "string",
            "city": "string",
            "postal_code": "string",
            "state": "string",
            "country": "AD"
          }
        },
        "organization": {
          "legal_name": "string",
          "tax_id": "string",
          "tax_ids": [
            {
              "id": "string",
              "type": "GENERIC_TAX_ID",
              "tax_id_validation_result": {
                "id": "string",
                "validation_date": "string",
                "source": "string",
                "valid": "VALID",
                "message": "string"
              }
            }
          ],
          "registration_number": "string",
          "tax_exempt": true,
          "tax_exempt_note": "string",
          "registered_address": {
            "line1": "string",
            "line2": "string",
            "city": "string",
            "postal_code": "string",
            "state": "string",
            "country": "AD"
          },
          "tax_registrations": [
            {
              "id": "string",
              "description": "string",
              "tax_id": "string",
              "tax_ids": [
                {
                  "id": "string",
                  "type": "GENERIC_TAX_ID",
                  "tax_id_validation_result": {
                    "id": "string",
                    "validation_date": "string",
                    "source": "string",
                    "valid": "VALID",
                    "message": "string"
                  }
                }
              ],
              "registration_number": "string",
              "registered_address": {
                "line1": "string",
                "line2": "string",
                "city": "string",
                "postal_code": "string",
                "state": "string",
                "country": "AD"
              }
            }
          ]
        },
        "custom_fields": [
          {
            "id": "string",
            "reference": "string",
            "value": "string",
            "values": [
              "string"
            ],
            "integration_details": {
              "payment_gateway_variant": "ADYEN",
              "id": "string",
              "reference": "string",
              "adyen": {
                "recurring_detail_reference": "string"
              },
              "stripe": {
                "payment_method_id": "string"
              }
            }
          }
        ],
        "processing_only": true,
        "pricing_plan_subscription_selector": {
          "data": [
            {
              "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
              "value": "string"
            }
          ],
          "rules": [
            {
              "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
              "type": "EQUALS"
            }
          ],
          "filters": [
            {
              "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
              "type": "EQUALS",
              "value": "string"
            }
          ],
          "fallback": "LATEST"
        },
        "linked_integrations": [
          {
            "id": "string",
            "link_details": [
              {
                "url": "string",
                "custom_field_name": "string"
              }
            ]
          }
        ]
      },
      "status": "SCHEDULED",
      "created_at": "string",
      "execute_at": "string",
      "index": 1,
      "amount": {
        "quantity": "string",
        "currency": "AED"
      }
    }
  ],
  "page": 1,
  "limit": 1,
  "links": {
    "first": "string",
    "previous": "string",
    "current": "string",
    "next": "string"
  },
  "total_number_of_pages": 1
}

Requires the PAYMENT_REQUEST.VIEW permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

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

Path parameters

versionstringRequiredDefaults to 1

version

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

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

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

Authentication

Path parameters

Headers

Query parameters

Response

Errors