Get a Payment Method by ID
get
/paymentMethod/{paymentMethodId}
Gets the specified payment method.
Request
Path Parameters
-
paymentMethodId(required): string
The ID of the payment method to get.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
The payment method was returned successfully.
Root 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
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
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 relatedParty
-
status: string
The payment method's status.
-
statusDate: string
(date-time)
The date the payment method's status was recorded.
-
validFor:
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
404 Response
Not Found
405 Response
Method not Allowed
500 Response
Internal Server Error
Examples
The following example shows how to get the payment method with the specified ID 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/0.0.0.1+-payinfo-dd+240947'
Example of the Response Body
The following example shows the contents of the response body in JSON format.
{ "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" } }