C# Class PayPal.Api.BankAccount

A resource representing a bank account that can be used to fund a payment.

See PayPal Developer documentation for more information.

Inheritance: PayPalRelationalObject
Mostra file Open project: paypal/PayPal-NET-SDK Class Usage Examples

Private Properties

Property Type Description

Public Methods

Method Description
Create ( APIContext apiContext ) : BankAccount

Creates a new Bank Account Resource.

Create ( APIContext apiContext, BankAccount bankAccount ) : BankAccount

Creates a new Bank Account Resource.

Delete ( APIContext apiContext ) : void

Delete the bank account resource for the given identifier.

Delete ( APIContext apiContext, string bankAccountId ) : void

Delete the bank account resource for the given identifier.

Get ( APIContext apiContext, string bankAccountId ) : BankAccount

Obtain the Bank Account resource for the given identifier.

List ( APIContext apiContext, int pageSize = 10, int page = 1, string startTime = "", string endTime = "", string sortOrder = "asc", string sortBy = "create_time", string merchantId = "", string externalCustomerId = "", string externalAccountId = "" ) : PayPal.Api.BankAccountList

Retrieves a list of bank account resources.

Update ( APIContext apiContext, PatchRequest patchRequest ) : BankAccount

Update information in a previously saved bank account. Only the modified fields need to be passed in the request.

Update ( APIContext apiContext, string bankAccountId, PatchRequest patchRequest ) : BankAccount

Update information in a previously saved bank account. Only the modified fields need to be passed in the request.

Method Details

Create() public method

Creates a new Bank Account Resource.
public Create ( APIContext apiContext ) : BankAccount
apiContext APIContext APIContext used for the API call.
return BankAccount

Create() public static method

Creates a new Bank Account Resource.
public static Create ( APIContext apiContext, BankAccount bankAccount ) : BankAccount
apiContext APIContext APIContext used for the API call.
bankAccount BankAccount The BankAccount object specifying the details of the PayPal resource to create.
return BankAccount

Delete() public method

Delete the bank account resource for the given identifier.
public Delete ( APIContext apiContext ) : void
apiContext APIContext APIContext used for the API call.
return void

Delete() public static method

Delete the bank account resource for the given identifier.
public static Delete ( APIContext apiContext, string bankAccountId ) : void
apiContext APIContext APIContext used for the API call.
bankAccountId string Identifier of the bank account resource to obtain the data for.
return void

Get() public static method

Obtain the Bank Account resource for the given identifier.
public static Get ( APIContext apiContext, string bankAccountId ) : BankAccount
apiContext APIContext APIContext used for the API call.
bankAccountId string Identifier of the bank account resource to obtain the data for.
return BankAccount

List() public static method

Retrieves a list of bank account resources.
public static List ( APIContext apiContext, int pageSize = 10, int page = 1, string startTime = "", string endTime = "", string sortOrder = "asc", string sortBy = "create_time", string merchantId = "", string externalCustomerId = "", string externalAccountId = "" ) : PayPal.Api.BankAccountList
apiContext APIContext APIContext used for the API call.
pageSize int Number of items to be returned in the current page size, by a GET operation. Defaults to a size of 10.
page int The page number to be retrieved, for the list of items, by the current GET request. Defaults to a size of 1.
startTime string Resource creation time as ISO8601 date-time format (ex: 1994-11-05T13:15:30Z) that indicates the start of a range of results.
endTime string Resource creation time as ISO8601 date-time format (ex: 1994-11-05T13:15:30Z) that indicates the end of a range of results.
sortOrder string Sort based on order of results. Options include 'asc' for ascending order or 'desc' for descending order. Defaults to 'asc'.
sortBy string Sort based on 'create_time' or 'update_time'. Defaults to 'create_time'.
merchantId string Identifier the merchants who owns this resource
externalCustomerId string Identifier of the external customer resource to obtain the data for.
externalAccountId string Identifier of the external bank account resource id to obtain the data for.
return PayPal.Api.BankAccountList

Update() public method

Update information in a previously saved bank account. Only the modified fields need to be passed in the request.
public Update ( APIContext apiContext, PatchRequest patchRequest ) : BankAccount
apiContext APIContext APIContext used for the API call.
patchRequest PatchRequest PatchRequest
return BankAccount

Update() public static method

Update information in a previously saved bank account. Only the modified fields need to be passed in the request.
public static Update ( APIContext apiContext, string bankAccountId, PatchRequest patchRequest ) : BankAccount
apiContext APIContext APIContext used for the API call.
bankAccountId string ID of the bank account to update.
patchRequest PatchRequest PatchRequest
return BankAccount