Retrieves available payment methods for a specific transaction or purchase.
The order in which the payment methods are displayed to the customer should be the same as the order in the response.
The list of payment methods is generated from available gateway accounts and the last matched adjust-ready-to-pay
action on the ready-to-pay-requested
event.
If no rules match for the specific request, all methods supported by the gateway accounts are sent.
To invert this behavior, place an all matching rule at the end of the ready-to-pay-requested
event in the rules engine,
and include an empty paymentMethods
property for the adjust-ready-to-pay
action.
For more information, see Update event rules and Gateway accounts.
websiteId required | string (WebsiteId) <= 50 characters ID of the website. A website is where an organization obtains a customer. For more information, see Obtain an organization ID and website ID. |
currency required | string (CurrencyCode) = 3 characters Currency code in ISO 4217 format. |
amount required | number <double> Amount to pay. |
object Billing address. | |
required | object (Risk metadata) Risk metadata used for 3D Secure and risk scoring. |
customerId | string (CustomerId) <= 50 characters ID of the customer resource. |
Payment methods retrieved.
method required | string Payment method. |
object or null Specific feature of this method. For example, a digital wallet. If the method does not have any features, this value is null. | |
brands | Array of strings (PaymentCardBrand) non-empty List of supported brands. |
filters | Array of strings (ReadyToPayMethodFilters) For the method to be applicable, one or more of the following filters must match. If no filters are sent, no restrictions are applied. For more information, see Using filters. |
Unauthorized access. Invalid credentials used.
Access forbidden.
Invalid data sent.
{- "websiteId": "web_0YV7DE4Z26DQSA1AC92FBJ7SEG",
- "currency": "USD",
- "amount": 0,
- "billingAddress": {
- "firstName": "Benjamin",
- "lastName": "Franklin",
- "organization": "Rebilly",
- "address": "36 Craven St",
- "address2": "string",
- "city": "Austin",
- "region": "Texas",
- "country": "GB",
- "postalCode": "WC2N 5NF",
- "phoneNumbers": [
- {
- "label": "main",
- "value": "512-710-1640",
- "primary": true
}
], - "emails": [
- {
- "label": "main",
- "value": "rebilly@example.com",
- "primary": true
}
], - "dob": "1980-04-01",
- "jobTitle": "CEO"
}, - "riskMetadata": {
- "ipAddress": "93.92.91.90",
- "fingerprint": "pIUt3xbgX3l9g3YDiLbx",
- "httpHeaders": {
- "Content-Type": "application/json",
- "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"
}, - "browserData": {
- "colorDepth": 24,
- "isJavaEnabled": true,
- "language": "en-US",
- "screenWidth": 1920,
- "screenHeight": 1080,
- "timeZoneOffset": 300
}, - "extraData": {
- "kountFraudSessionId": "abcdefg12345abababab123456789012",
- "payPalMerchantSessionId": "dd65ratxc5qv15iph3vyoq7l6davuowa",
- "threatMetrixSessionId": "dd65ratxc5qv15iph3vyoq7l6davuowadd65ratxc5qv15iph3vyoq7l6davuowa"
}
}, - "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF"
}
[- {
- "method": "payment-card",
- "feature": {
- "name": "Apple Pay",
- "displayName": "Test Merchant",
- "country": "US"
}, - "brands": [
- "Visa"
], - "filters": [
- "string"
]
}
]