Get a Payment Request by ID

GET

/v:version/payment-requests/:resourceId

GET

/v:version/payment-requests/:resourceId

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

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

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

resourceIdstringRequiredDefaults to

The ID of the resource to be requested.

Query parameters

expand[]list of stringsOptional

The id fields of the resources that are going to be expanded.

Response

object_typestring or nullOptionalRead-only

idstring or nullOptionalRead-only

payment_schedule_idstring or nullOptionalRead-only

The id of the payment schedule

customer_idstring or nullOptionalRead-only

The id of the customer

customerobject or nullOptional

statusenum or nullOptionalRead-only

The status of the payment request

created_atstring or nullOptionalRead-only

The moment the payment request was created

execute_atstring or nullOptionalRead-only

The moment the payment request must be executed

indexinteger or nullOptionalRead-only

The index of the payment request of the payment schedule

amountobject or nullOptional

The amount of the payment request

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors