This method returns the payment methods that are allowed to be used by payments of a specific type. Multiple payment methods are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
payment_type_identifier (mandatory) | Financial Transaction Type Identifier | The identifier of the type of the payment that will be using the payment methods. The payment methods are filtered against the allowed payment methods of the specified type. The allowed financial transaction type identifier fields are the following:
| ||||||||||||
| fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Response Data
| Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved payment type payment method |
| default | Boolean | Determines if the payment type payment method is the default payment method or not |
Payment Method Object | The actual payment method supported by the payment type |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
[
{
"default": true,
"payment_method":
{
"id": "PM7",
"name": "Bank Transfer",
"description": "Bank Transfer",
"alternative_code": "BT"
},
"id": "C9441F357B22A2E7ECE1C0AB9C47ED96"
},
{
"default": false,
"payment_method":
{
"id": "E239F9E5D1B43BE5734ADA8DD8BE535B",
"name": "Paypal",
"description": "Paypal",
"alternative_code": "P"
},
"id": "4877F44AFD415A58CB823549FC418AAD"
}
]
}