Account Payment Information

Available methods

GET /v1/api/accounts/{customerID}/payment 

This method retrieves payment information for a Partner or an account.

Input Parameters

#ParameterParameter TypeData TypeMandatoryDescription/Valid Values
1 customerID path string Required

Identifies the Partner or account

Output Parameters

PaymentGetV1Model

PaymentGetV1Model { type (string): The account payment type = ['paperCheck', 'creditCard'] }

Response Class (Status 200)

Returns an object describing the payment method for the Partner or account.

Note: only the payment type is returned

Response example

The payment method for the specified account ( customerID ) is displayed:

Response Body example

{ "type": "creditCard" }

Possible error response messages

PUT /v1/api/accounts/{customerID}/payment 

The method updates payment information for the account.

Input Parameters

#ParameterParameter TypeData TypeMandatoryDescription/Valid Values
1 customerID path string Required

Identifies the Partner or account

2 payment body PaymentV1Model
Required

New payment information

Output Parameters

PaymentGetV1Model

PaymentGetV1ModelPaymentGetV1Model { type (string): The account payment type = ['paperCheck', 'creditCard'] }

Response Class (Status 200)

Returns an object describing the updated payment method.

Note. Due to security concerns, only the payment type is returned.

Request and response examples

Request

Description of new payment method data (changing the payment method type on paperCheck for the account from the previous method):

Request Body example

payment

{ "name": " Company name ",
"phone": "12365458789",
"address": {
"country": "United States",
"state": "California",
"city": "Anaheim",
"street": "104 South Anaheim Boulevard",
"zip": "92805-6010"
},
"type": "paperCheck" }

Updated type of payment method is displayed:

Possible error response messages