Get Available Payment Methods

GET

https://api.payos.money/v1/payment/available-methods

GET

/v1/payment/available-methods

1 curl -G https://api.payos.money/v1/payment/available-methods \
2      -d sessionId=sessionId

Try it

200Retrieved

1 {
2   "success": true,
3   "availableMethods": [
4     {
5       "type": "card",
6       "name": "Credit/Debit Card",
7       "requiredInput": [
8         {
9           "name": "cardNumber",
10           "type": "text",
11           "label": "PAN"
12         },
13         {
14           "name": "expiryDate",
15           "type": "text",
16           "label": "Expiry Date (MM/YY)"
17         },
18         {
19           "name": "cvv",
20           "type": "text",
21           "label": "CVV"
22         },
23         {
24           "name": "cardholderName",
25           "type": "text",
26           "label": "Cardholder Name"
27         }
28       ],
29       "captureCredentialsExternally": true
30     },
31     {
32       "type": "payByBank",
33       "name": "Pay by Bank",
34       "requiredInput": [
35         {
36           "name": "bankName",
37           "type": "select",
38           "label": "Select Bank",
39           "options": [
40             "Bank A",
41             "Bank B",
42             "Bank C"
43           ]
44         }
45       ],
46       "captureCredentialsExternally": true
47     },
48     {
49       "type": "mobileMoney",
50       "name": "Mobile Money",
51       "requiredInput": [
52         {
53           "name": "phoneNumber",
54           "type": "text",
55           "label": "Phone Number"
56         },
57         {
58           "name": "provider",
59           "type": "select",
60           "label": "Mobile Money Provider",
61           "options": [
62             "Provider A",
63             "Provider B",
64             "Provider C"
65           ]
66         }
67       ],
68       "captureCredentialsExternally": true
69     }
70   ]
71 }

Returns available payment methods based on the session.

Query parameters

sessionIdstringRequired

Unique identifier for the session.

Response

Available payment methods retrieved successfully.

successboolean or nullDefaults to false

Indicates if the request was successful.

availableMethodslist of objects or null

Query parameters

Response

Errors