List payment gateway account information

Request

HTTP request

GET /v2/accounts/{accountId}/payment_gateway_accounts

Parameters

Parameter name Value Description
Path parameters
accountId string

The external account number (int) or account ID Guid.

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Accounts::getAllPaymentGatewayAccounts

Definitions Expand All | Collapse All

PaymentGatewayAccounts

Information about a connected payment gateway account.

displayName string

A user-defined name for a connected gateway account.

This name is used in the Admin panel in the list of connected accounts and in Tagger in the payment gateway selector.

The human-readable version of paymentGatewayAccountId.

paymentGateway string

Payment gateway used by the connected gateway account. This is the name used by the API. For a human-readable version use paymentGatewayDisplayName.

Possible values are:

  • Stripe
  • Braintree
  • AuthorizeDotNet
paymentGatewayAccountId string

A GUID that identifies the payment gateway account. For a human-readable version use displayName.

paymentGatewayDisplayName string

Display name of the payment gateway used by the connected gateway account. This is the human-readable version of paymentGateway.

Possible values are:

  • Stripe
  • Braintree
  • Authorize.Net

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCode string

An error code associated with the error.

message string

A short error message.

paymentGatewayAccountsInfo

Holds information about connected payment accounts.

paymentGatewayAccounts
[PaymentGatewayAccounts]

A list of payment gateway accounts.

Examples

Generic JSON Response

Response

{
"paymentGatewayAccounts": [
{
"paymentGatewayAccountId": "sample string 1",
"paymentGateway": "sample string 2",
"displayName": "sample string 3",
"paymentGatewayDisplayName": "sample string 4"
}
]
}

Generic XML Response

Response

<paymentGatewayAccounts 
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.docusign.com/restapi">

<paymentGatewayAccounts>
<paymentGatewayAccount>
<displayName>sample string 3</displayName>
<paymentGateway>sample string 2</paymentGateway>
<paymentGatewayAccountId>sample string 1</paymentGatewayAccountId>
<paymentGatewayDisplayName>sample string 4</paymentGatewayDisplayName>
</paymentGatewayAccount>
</paymentGatewayAccounts>
</paymentGatewayAccounts>