Get Payment Methods
get
/paymentMethod
Gets the payment methods that match the query criteria.
Request
Query Parameters
-
bankAccount.BIC: string
The Business Identifier Code of a bank, to get bankAccountDebit payment methods.Example:
AAAABBCCDD
-
bankAccount.accountNumber: string
The account number, to get a bankAccountDebit payment method.Example:
1234567890
-
bankAccount.bank: string
The name of a bank, to get bankAccountDebit payment methods.Example:
My Bank
-
bankCard.cardNumber: string
The card number, to get a bankCard payment method.Example:
5.111111111111118E15
-
bankCard.nameOnCard: string
The name on the card, to get bankCard payment methods. You can use bankCard.nameOnCard.like= to get partial matches.Example:
John%20Smith
-
bankCard.type: string
The type of bank card, to get bankCard payment methods. The only valid value for BRM is CREDIT.Example:
CREDIT
-
fields: string
The list of comma-separated fields to return in the response.Example:
account,bankCard.nameOnCard
-
limit: integer
The maximum number of results to return. For example, use limit=10 to return the first 10 results only.Example:
10
-
offset: integer
The number of results to offset the response by. For example, use offset=10 to return results 10 and higher.Example:
10
-
relatedParty.id: string
The ID of a related party to get payment methods for.Example:
0.0.0.1+-account+107117
-
relatedParty.type: string
The type of related party to get payment methods for.
-
type: string
The type of payment method to get.Allowed Values:
[ "tokenizedCard", "bankAccountDebit", "bankCard" ]
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
The payment methods were returned successfully.
Headers
-
X-Total-Count(required):
The total number of results.
Nested Schema : PaymentMethodType
Type:
object
A payment method.
Show Source
-
@type(required): string
Allowed Values:
[ "tokenizedCard", "bankAccountDebit", "bankCard" ]
The payment method's type. The value of this property determines the content of the details property. -
account: array
array
account
An account that owns or can use the payment method.
-
authorizationCode: string
An authorization code provided by a financial institution. Typically for recurring payments using the payment method.
-
description: string
The payment method's description.
-
details(required): object
object
details
The payment method's details, which differ based on the '@type' property.
-
href(required): string
The payment method's href.
-
id(required): string
The payment method's ID.
-
name: string
The payment method's name.
-
preferred: boolean
Whether this is the preferred payment method for the account, bill unit, or billing cycle specification (true) or not (false).
- relatedParty: array array relatedParty
-
status: string
The payment method's status.
-
statusDate: string
(date-time)
The date the payment method's status was recorded.
-
validFor:
object
TimePeriodType
A period of time.
Nested Schema : account
Type:
array
An account that owns or can use the payment method.
Show Source
-
Array of:
object AccountRefType
An account reference.
Nested Schema : details
Type:
object
The payment method's details, which differ based on the '@type' property.
Nested Schema : TimePeriodType
Type:
object
A period of time.
Show Source
-
endDateTime: string
(date-time)
The end of the time period.
-
startDateTime(required): string
(date-time)
The start of the time period.
Nested Schema : AccountRefType
Type:
object
An account reference.
Show Source
-
@referredType: string
The referred account's type. For example, customer account or financial account.
-
description: string
The referred account's description.
-
href(required): string
The referred account's href.
-
id(required): string
The referred account's ID.
-
name: string
The referred account's name.
Nested Schema : RelatedPartyRefType
Type:
object
A related party.
Show Source
-
@referredType: string
The type of related party. For example, account, customer, or user.
-
href(required): string
The related party's href.
-
id(required): string
The related party's ID.
-
name: string
The related party's name.
-
role: string
The related party's role.
400 Response
Invalid Token
401 Response
Unauthorized
403 Response
Forbidden
405 Response
Method not Allowed
500 Response
Internal Server Error
Examples
The following example shows how to get a list of no more than two bankAccountDebit payment methods at the My Bank bank by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X GET 'http://host:port/brm/paymentMethods/version/paymentMethod?type=bankAccountDebit&limit=2'
Example of the Response Body
The following example shows the contents of the response body in JSON format. Because of the query criteria, only two debit accounts are shown.
[ { "id": "0.0.0.1+-payinfo-dd+240947", "href": "http://host:port/brm/paymentMethods/version/paymentMethod/0.0.0.1+-payinfo-dd+240947", "name": "Mary Robbin's Direct Debit Account", "description": null, "validFor": null, "account": [ { "id": "0.0.0.1+-account+244543", "href": null, "description": "Mary's Primary Account", "name": "Mary Robbins", "@baseType": null, "@schemaLocation": null, "@type": null, "@referredType": null } ], "preferred": true, "relatedParty": null, "@type": "bankAccountDebit", "authorizationCode": null, "status": null, "statusDate": null, "details": { "accountNumber": "12341234123412341", "accountNumberType": "Savings", "BIC": "111122334", "owner": "Mary Robbins", "bank": "My Bank" } }, { "id": "0.0.0.1+-payinfo-dd+249648", "href": "http://host:port/brm/paymentMethods/version/paymentMethod/0.0.0.1+-payinfo-dd+249648", "name": "Grace Wang's Direct Debit Account", "description": null, "validFor": null, "account": [ { "id": "0.0.0.1+-account+104221", "href": null, "description": "Grace's Primary Account", "name": "Grace Wang", "@baseType": null, "@schemaLocation": null, "@type": null, "@referredType": null } ], "preferred": true, "relatedParty": null, "@type": "bankAccountDebit", "authorizationCode": null, "status": null, "statusDate": null, "details": { "accountNumber": "12345678901236491", "accountNumberType": "Savings", "BIC": "111122334", "owner": "Grace Wang", "bank": "My Bank" } } ]